1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2016 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Functions concerned with verifying things. The original code for callout
9 caching was contributed by Kevin Fleming (but I hacked it around a bit). */
13 #include "transports/smtp.h"
15 #define CUTTHROUGH_CMD_TIMEOUT 30 /* timeout for cutthrough-routing calls */
16 #define CUTTHROUGH_DATA_TIMEOUT 60 /* timeout for cutthrough-routing calls */
17 static smtp_outblock ctblock;
18 uschar ctbuffer[8192];
21 /* Structure for caching DNSBL lookups */
23 typedef struct dnsbl_cache_block {
32 /* Anchor for DNSBL cache */
34 static tree_node *dnsbl_cache = NULL;
37 /* Bits for match_type in one_check_dnsbl() */
42 static uschar cutthrough_response(char, uschar **);
45 /*************************************************
46 * Retrieve a callout cache record *
47 *************************************************/
49 /* If a record exists, check whether it has expired.
52 dbm_file an open hints file
54 type "address" or "domain"
55 positive_expire expire time for positive records
56 negative_expire expire time for negative records
58 Returns: the cache record if a non-expired one exists, else NULL
61 static dbdata_callout_cache *
62 get_callout_cache_record(open_db *dbm_file, const uschar *key, uschar *type,
63 int positive_expire, int negative_expire)
68 dbdata_callout_cache *cache_record;
70 cache_record = dbfn_read_with_length(dbm_file, key, &length);
72 if (cache_record == NULL)
74 HDEBUG(D_verify) debug_printf("callout cache: no %s record found for %s\n", type, key);
78 /* We treat a record as "negative" if its result field is not positive, or if
79 it is a domain record and the postmaster field is negative. */
81 negative = cache_record->result != ccache_accept ||
82 (type[0] == 'd' && cache_record->postmaster_result == ccache_reject);
83 expire = negative? negative_expire : positive_expire;
86 if (now - cache_record->time_stamp > expire)
88 HDEBUG(D_verify) debug_printf("callout cache: %s record expired for %s\n", type, key);
92 /* If this is a non-reject domain record, check for the obsolete format version
93 that doesn't have the postmaster and random timestamps, by looking at the
94 length. If so, copy it to a new-style block, replicating the record's
95 timestamp. Then check the additional timestamps. (There's no point wasting
96 effort if connections are rejected.) */
98 if (type[0] == 'd' && cache_record->result != ccache_reject)
100 if (length == sizeof(dbdata_callout_cache_obs))
102 dbdata_callout_cache *new = store_get(sizeof(dbdata_callout_cache));
103 memcpy(new, cache_record, length);
104 new->postmaster_stamp = new->random_stamp = new->time_stamp;
108 if (now - cache_record->postmaster_stamp > expire)
109 cache_record->postmaster_result = ccache_unknown;
111 if (now - cache_record->random_stamp > expire)
112 cache_record->random_result = ccache_unknown;
115 HDEBUG(D_verify) debug_printf("callout cache: found %s record for %s\n", type, key);
121 /*************************************************
122 * Do callout verification for an address *
123 *************************************************/
125 /* This function is called from verify_address() when the address has routed to
126 a host list, and a callout has been requested. Callouts are expensive; that is
127 why a cache is used to improve the efficiency.
130 addr the address that's been routed
131 host_list the list of hosts to try
132 tf the transport feedback block
134 ifstring "interface" option from transport, or NULL
135 portstring "port" option from transport, or NULL
136 protocolstring "protocol" option from transport, or NULL
137 callout the per-command callout timeout
138 callout_overall the overall callout timeout (if < 0 use 4*callout)
139 callout_connect the callout connection timeout (if < 0 use callout)
140 options the verification options - these bits are used:
141 vopt_is_recipient => this is a recipient address
142 vopt_callout_no_cache => don't use callout cache
143 vopt_callout_fullpm => if postmaster check, do full one
144 vopt_callout_random => do the "random" thing
145 vopt_callout_recipsender => use real sender for recipient
146 vopt_callout_recippmaster => use postmaster for recipient
147 se_mailfrom MAIL FROM address for sender verify; NULL => ""
148 pm_mailfrom if non-NULL, do the postmaster check with this sender
150 Returns: OK/FAIL/DEFER
154 do_callout(address_item *addr, host_item *host_list, transport_feedback *tf,
155 int callout, int callout_overall, int callout_connect, int options,
156 uschar *se_mailfrom, uschar *pm_mailfrom)
159 int old_domain_cache_result = ccache_accept;
162 uschar *from_address;
163 uschar *random_local_part = NULL;
164 const uschar *save_deliver_domain = deliver_domain;
165 uschar **failure_ptr = options & vopt_is_recipient
166 ? &recipient_verify_failure : &sender_verify_failure;
168 open_db *dbm_file = NULL;
169 dbdata_callout_cache new_domain_record;
170 dbdata_callout_cache_address new_address_record;
172 time_t callout_start_time;
173 uschar peer_offered = 0;
175 new_domain_record.result = ccache_unknown;
176 new_domain_record.postmaster_result = ccache_unknown;
177 new_domain_record.random_result = ccache_unknown;
179 memset(&new_address_record, 0, sizeof(new_address_record));
181 /* For a recipient callout, the key used for the address cache record must
182 include the sender address if we are using the real sender in the callout,
183 because that may influence the result of the callout. */
185 address_key = addr->address;
188 if (options & vopt_is_recipient)
190 if (options & vopt_callout_recipsender)
192 address_key = string_sprintf("%s/<%s>", addr->address, sender_address);
193 from_address = sender_address;
194 if (cutthrough.delivery) options |= vopt_callout_no_cache;
196 else if (options & vopt_callout_recippmaster)
198 address_key = string_sprintf("%s/<postmaster@%s>", addr->address,
199 qualify_domain_sender);
200 from_address = string_sprintf("postmaster@%s", qualify_domain_sender);
204 /* For a sender callout, we must adjust the key if the mailfrom address is not
209 from_address = (se_mailfrom == NULL)? US"" : se_mailfrom;
210 if (from_address[0] != 0)
211 address_key = string_sprintf("%s/<%s>", addr->address, from_address);
214 /* Open the callout cache database, it it exists, for reading only at this
215 stage, unless caching has been disabled. */
217 if (options & vopt_callout_no_cache)
219 HDEBUG(D_verify) debug_printf("callout cache: disabled by no_cache\n");
221 else if ((dbm_file = dbfn_open(US"callout", O_RDWR, &dbblock, FALSE)) == NULL)
223 HDEBUG(D_verify) debug_printf("callout cache: not available\n");
226 /* If a cache database is available see if we can avoid the need to do an
227 actual callout by making use of previously-obtained data. */
231 dbdata_callout_cache_address *cache_address_record;
232 dbdata_callout_cache *cache_record = get_callout_cache_record(dbm_file,
233 addr->domain, US"domain",
234 callout_cache_domain_positive_expire,
235 callout_cache_domain_negative_expire);
237 /* If an unexpired cache record was found for this domain, see if the callout
238 process can be short-circuited. */
242 /* In most cases, if an early command (up to and including MAIL FROM:<>)
243 was rejected, there is no point carrying on. The callout fails. However, if
244 we are doing a recipient verification with use_sender or use_postmaster
245 set, a previous failure of MAIL FROM:<> doesn't count, because this time we
246 will be using a non-empty sender. We have to remember this situation so as
247 not to disturb the cached domain value if this whole verification succeeds
248 (we don't want it turning into "accept"). */
250 old_domain_cache_result = cache_record->result;
252 if (cache_record->result == ccache_reject ||
253 (*from_address == 0 && cache_record->result == ccache_reject_mfnull))
255 setflag(addr, af_verify_nsfail);
257 debug_printf("callout cache: domain gave initial rejection, or "
258 "does not accept HELO or MAIL FROM:<>\n");
259 setflag(addr, af_verify_nsfail);
260 addr->user_message = US"(result of an earlier callout reused).";
262 *failure_ptr = US"mail";
266 /* If a previous check on a "random" local part was accepted, we assume
267 that the server does not do any checking on local parts. There is therefore
268 no point in doing the callout, because it will always be successful. If a
269 random check previously failed, arrange not to do it again, but preserve
270 the data in the new record. If a random check is required but hasn't been
271 done, skip the remaining cache processing. */
273 if (options & vopt_callout_random) switch(cache_record->random_result)
277 debug_printf("callout cache: domain accepts random addresses\n");
278 goto END_CALLOUT; /* Default yield is OK */
282 debug_printf("callout cache: domain rejects random addresses\n");
283 options &= ~vopt_callout_random;
284 new_domain_record.random_result = ccache_reject;
285 new_domain_record.random_stamp = cache_record->random_stamp;
290 debug_printf("callout cache: need to check random address handling "
291 "(not cached or cache expired)\n");
295 /* If a postmaster check is requested, but there was a previous failure,
296 there is again no point in carrying on. If a postmaster check is required,
297 but has not been done before, we are going to have to do a callout, so skip
298 remaining cache processing. */
302 if (cache_record->postmaster_result == ccache_reject)
304 setflag(addr, af_verify_pmfail);
306 debug_printf("callout cache: domain does not accept "
307 "RCPT TO:<postmaster@domain>\n");
309 *failure_ptr = US"postmaster";
310 setflag(addr, af_verify_pmfail);
311 addr->user_message = US"(result of earlier verification reused).";
314 if (cache_record->postmaster_result == ccache_unknown)
317 debug_printf("callout cache: need to check RCPT "
318 "TO:<postmaster@domain> (not cached or cache expired)\n");
322 /* If cache says OK, set pm_mailfrom NULL to prevent a redundant
323 postmaster check if the address itself has to be checked. Also ensure
324 that the value in the cache record is preserved (with its old timestamp).
327 HDEBUG(D_verify) debug_printf("callout cache: domain accepts RCPT "
328 "TO:<postmaster@domain>\n");
330 new_domain_record.postmaster_result = ccache_accept;
331 new_domain_record.postmaster_stamp = cache_record->postmaster_stamp;
335 /* We can't give a result based on information about the domain. See if there
336 is an unexpired cache record for this specific address (combined with the
337 sender address if we are doing a recipient callout with a non-empty sender).
340 cache_address_record = (dbdata_callout_cache_address *)
341 get_callout_cache_record(dbm_file,
342 address_key, US"address",
343 callout_cache_positive_expire,
344 callout_cache_negative_expire);
346 if (cache_address_record)
348 if (cache_address_record->result == ccache_accept)
351 debug_printf("callout cache: address record is positive\n");
356 debug_printf("callout cache: address record is negative\n");
357 addr->user_message = US"Previous (cached) callout verification failure";
358 *failure_ptr = US"recipient";
364 /* Close the cache database while we actually do the callout for real. */
367 dbfn_close(dbm_file);
371 if (!addr->transport)
373 HDEBUG(D_verify) debug_printf("cannot callout via null transport\n");
375 else if (Ustrcmp(addr->transport->driver_name, "smtp") != 0)
376 log_write(0, LOG_MAIN|LOG_PANIC|LOG_CONFIG_FOR, "callout transport '%s': %s is non-smtp",
377 addr->transport->name, addr->transport->driver_name);
380 smtp_transport_options_block *ob =
381 (smtp_transport_options_block *)addr->transport->options_block;
383 /* The information wasn't available in the cache, so we have to do a real
384 callout and save the result in the cache for next time, unless no_cache is set,
385 or unless we have a previously cached negative random result. If we are to test
386 with a random local part, ensure that such a local part is available. If not,
387 log the fact, but carry on without randomming. */
389 if (options & vopt_callout_random && callout_random_local_part != NULL)
390 if (!(random_local_part = expand_string(callout_random_local_part)))
391 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand "
392 "callout_random_local_part: %s", expand_string_message);
394 /* Default the connect and overall callout timeouts if not set, and record the
395 time we are starting so that we can enforce it. */
397 if (callout_overall < 0) callout_overall = 4 * callout;
398 if (callout_connect < 0) callout_connect = callout;
399 callout_start_time = time(NULL);
401 /* Before doing a real callout, if this is an SMTP connection, flush the SMTP
402 output because a callout might take some time. When PIPELINING is active and
403 there are many recipients, the total time for doing lots of callouts can add up
404 and cause the client to time out. So in this case we forgo the PIPELINING
407 if (smtp_out && !disable_callout_flush) mac_smtp_fflush();
409 /* cutthrough-multi: if a nonfirst rcpt has the same routing as the first,
410 and we are holding a cutthrough conn open, we can just append the rcpt to
411 that conn for verification purposes (and later delivery also). Simplest
412 coding means skipping this whole loop and doing the append separately.
414 We will need to remember it has been appended so that rcpt-acl tail code
415 can do it there for the non-rcpt-verify case. For this we keep an addresscount.
418 /* Can we re-use an open cutthrough connection? */
419 if ( cutthrough.fd >= 0
420 && (options & (vopt_callout_recipsender | vopt_callout_recippmaster))
421 == vopt_callout_recipsender
422 && !random_local_part
426 if (addr->transport == cutthrough.addr.transport)
427 for (host = host_list; host; host = host->next)
428 if (Ustrcmp(host->address, cutthrough.host.address) == 0)
431 uschar *interface = NULL; /* Outgoing interface to use; NULL => any */
434 deliver_host = host->name;
435 deliver_host_address = host->address;
436 deliver_host_port = host->port;
437 deliver_domain = addr->domain;
438 transport_name = addr->transport->name;
440 host_af = (Ustrchr(host->address, ':') == NULL)? AF_INET:AF_INET6;
442 if (!smtp_get_interface(tf->interface, host_af, addr, &interface,
444 !smtp_get_port(tf->port, addr, &port, US"callout"))
445 log_write(0, LOG_MAIN|LOG_PANIC, "<%s>: %s", addr->address,
448 if ( ( interface == cutthrough.interface
450 && cutthrough.interface
451 && Ustrcmp(interface, cutthrough.interface) == 0
453 && port == cutthrough.host.port
456 uschar * resp = NULL;
458 /* Match! Send the RCPT TO, append the addr, set done */
460 smtp_write_command(&ctblock, FALSE, "RCPT TO:<%.1000s>\r\n",
461 transport_rcpt_address(addr,
462 (addr->transport == NULL)? FALSE :
463 addr->transport->rcpt_include_affixes)) >= 0 &&
464 cutthrough_response('2', &resp) == '2';
466 /* This would go horribly wrong if a callout fail was ignored by ACL.
467 We punt by abandoning cutthrough on a reject, like the
472 address_item * na = store_get(sizeof(address_item));
473 *na = cutthrough.addr;
474 cutthrough.addr = *addr;
475 cutthrough.addr.host_used = &cutthrough.host;
476 cutthrough.addr.next = na;
482 cancel_cutthrough_connection("recipient rejected");
483 if (!resp || errno == ETIMEDOUT)
485 HDEBUG(D_verify) debug_printf("SMTP timeout\n");
490 Ustrcpy(resp, US"connection dropped");
493 string_sprintf("response to \"%s\" from %s [%s] was: %s",
494 big_buffer, host->name, host->address,
495 string_printing(resp));
498 string_sprintf("Callout verification failed:\n%s", resp);
500 /* Hard rejection ends the process */
502 if (resp[0] == '5') /* Address rejected */
513 cancel_cutthrough_connection("incompatible connection");
516 /* Now make connections to the hosts and do real callouts. The list of hosts
517 is passed in as an argument. */
519 for (host = host_list; host && !done; host = host->next)
521 smtp_inblock inblock;
522 smtp_outblock outblock;
525 BOOL send_quit = TRUE;
526 uschar *active_hostname = smtp_active_hostname;
530 BOOL suppress_tls = FALSE;
531 uschar *interface = NULL; /* Outgoing interface to use; NULL => any */
532 #if defined(SUPPORT_TLS) && defined(EXPERIMENTAL_DANE)
535 dns_answer tlsa_dnsa;
537 uschar inbuffer[4096];
538 uschar outbuffer[1024];
539 uschar responsebuffer[4096];
542 clearflag(addr, af_verify_pmfail); /* postmaster callout flag */
543 clearflag(addr, af_verify_nsfail); /* null sender callout flag */
545 /* Skip this host if we don't have an IP address for it. */
549 DEBUG(D_verify) debug_printf("no IP address for host name %s: skipping\n",
554 /* Check the overall callout timeout */
556 if (time(NULL) - callout_start_time >= callout_overall)
558 HDEBUG(D_verify) debug_printf("overall timeout for callout exceeded\n");
562 /* Set IPv4 or IPv6 */
564 host_af = Ustrchr(host->address, ':') == NULL ? AF_INET : AF_INET6;
566 /* Expand and interpret the interface and port strings. The latter will not
567 be used if there is a host-specific port (e.g. from a manualroute router).
568 This has to be delayed till now, because they may expand differently for
569 different hosts. If there's a failure, log it, but carry on with the
572 deliver_host = host->name;
573 deliver_host_address = host->address;
574 deliver_host_port = host->port;
575 deliver_domain = addr->domain;
576 transport_name = addr->transport->name;
578 if ( !smtp_get_interface(tf->interface, host_af, addr, &interface,
580 || !smtp_get_port(tf->port, addr, &port, US"callout")
582 log_write(0, LOG_MAIN|LOG_PANIC, "<%s>: %s", addr->address,
585 /* Set HELO string according to the protocol */
586 lmtp= Ustrcmp(tf->protocol, "lmtp") == 0;
587 smtps= Ustrcmp(tf->protocol, "smtps") == 0;
590 HDEBUG(D_verify) debug_printf("interface=%s port=%d\n", interface, port);
592 /* Set up the buffer for reading SMTP response packets. */
594 inblock.buffer = inbuffer;
595 inblock.buffersize = sizeof(inbuffer);
596 inblock.ptr = inbuffer;
597 inblock.ptrend = inbuffer;
599 /* Set up the buffer for holding SMTP commands while pipelining */
601 outblock.buffer = outbuffer;
602 outblock.buffersize = sizeof(outbuffer);
603 outblock.ptr = outbuffer;
604 outblock.cmd_count = 0;
605 outblock.authenticating = FALSE;
607 /* Connect to the host; on failure, just loop for the next one, but we
608 set the error for the last one. Use the callout_connect timeout. */
610 tls_retry_connection:
612 /* Reset the parameters of a TLS session */
613 tls_out.cipher = tls_out.peerdn = tls_out.peercert = NULL;
615 inblock.sock = outblock.sock =
616 smtp_connect(host, host_af, port, interface, callout_connect,
618 if (inblock.sock < 0)
620 addr->message = string_sprintf("could not connect to %s [%s]: %s",
621 host->name, host->address, strerror(errno));
622 transport_name = NULL;
623 deliver_host = deliver_host_address = NULL;
624 deliver_domain = save_deliver_domain;
628 #if defined(SUPPORT_TLS) && defined(EXPERIMENTAL_DANE)
632 tls_out.dane_verified = FALSE;
633 tls_out.tlsa_usage = 0;
636 verify_check_given_host(&ob->hosts_require_dane, host) == OK;
638 if (host->dnssec == DS_YES)
641 || verify_check_given_host(&ob->hosts_try_dane, host) == OK
644 if ((rc = tlsa_lookup(host, &tlsa_dnsa, dane_required)) != OK)
649 else if (dane_required)
651 log_write(0, LOG_MAIN, "DANE error: %s lookup not DNSSEC", host->name);
656 ob->tls_tempfail_tryclear = FALSE;
660 /* Expand the helo_data string to find the host name to use. */
664 uschar * s = expand_string(tf->helo_data);
666 log_write(0, LOG_MAIN|LOG_PANIC, "<%s>: failed to expand transport's "
667 "helo_data value for callout: %s", addr->address,
668 expand_string_message);
669 else active_hostname = s;
672 /* Wait for initial response, and send HELO. The smtp_write_command()
673 function leaves its command in big_buffer. This is used in error responses.
674 Initialize it in case the connection is rejected. */
676 Ustrcpy(big_buffer, "initial connection");
678 /* Unless ssl-on-connect, wait for the initial greeting */
682 if (!smtps || (smtps && tls_out.active >= 0))
685 if (!(done= smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer), '2', callout)))
686 goto RESPONSE_FAILED;
688 #ifndef DISABLE_EVENT
689 lookup_dnssec_authenticated = host->dnssec==DS_YES ? US"yes"
690 : host->dnssec==DS_NO ? US"no" : NULL;
691 if (event_raise(addr->transport->event_action,
692 US"smtp:connect", responsebuffer))
694 lookup_dnssec_authenticated = NULL;
695 /* Logging? Debug? */
696 goto RESPONSE_FAILED;
698 lookup_dnssec_authenticated = NULL;
702 /* Not worth checking greeting line for ESMTP support */
703 if (!(esmtp = verify_check_given_host(&ob->hosts_avoid_esmtp, host) != OK))
705 debug_printf("not sending EHLO (host matches hosts_avoid_esmtp)\n");
710 if (smtps && tls_out.active < 0) /* ssl-on-connect, first pass */
712 peer_offered &= ~PEER_OFFERED_TLS;
713 ob->tls_tempfail_tryclear = FALSE;
715 else /* all other cases */
720 if (!(done= smtp_write_command(&outblock, FALSE, "%s %s\r\n",
721 !esmtp? "HELO" : lmtp? "LHLO" : "EHLO", active_hostname) >= 0))
723 if (!smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer), '2', callout))
725 if (errno != 0 || responsebuffer[0] == 0 || lmtp || !esmtp || tls_out.active >= 0)
728 goto RESPONSE_FAILED;
731 peer_offered &= ~PEER_OFFERED_TLS;
734 goto esmtp_retry; /* fallback to HELO */
737 /* Set tls_offered if the response to EHLO specifies support for STARTTLS. */
740 ? ehlo_response(responsebuffer, sizeof(responsebuffer),
741 (!suppress_tls && tls_out.active < 0 ? PEER_OFFERED_TLS : 0)
745 | (addr->prop.utf8_msg && !addr->prop.utf8_downcvt
746 ? PEER_OFFERED_UTF8 : 0)
751 /* only care about SIZE if we have size from inbound */
752 | (message_size > 0 && ob->size_addition >= 0
753 ? PEER_OFFERED_SIZE : 0)
758 size_str = peer_offered & PEER_OFFERED_SIZE
759 ? string_sprintf(" SIZE=%d", message_size + ob->size_addition) : US"";
762 smtp_peer_options |= peer_offered & PEER_OFFERED_TLS;
765 /* If TLS is available on this connection attempt to
766 start up a TLS session, unless the host is in hosts_avoid_tls. If successful,
767 send another EHLO - the server may give a different answer in secure mode. We
768 use a separate buffer for reading the response to STARTTLS so that if it is
769 negative, the original EHLO data is available for subsequent analysis, should
770 the client not be required to use TLS. If the response is bad, copy the buffer
771 for error analysis. */
774 if ( peer_offered & PEER_OFFERED_TLS
775 && verify_check_given_host(&ob->hosts_avoid_tls, host) != OK
776 && verify_check_given_host(&ob->hosts_verify_avoid_tls, host) != OK
779 uschar buffer2[4096];
781 && !(done= smtp_write_command(&outblock, FALSE, "STARTTLS\r\n") >= 0))
784 /* If there is an I/O error, transmission of this message is deferred. If
785 there is a temporary rejection of STARRTLS and tls_tempfail_tryclear is
786 false, we also defer. However, if there is a temporary rejection of STARTTLS
787 and tls_tempfail_tryclear is true, or if there is an outright rejection of
788 STARTTLS, we carry on. This means we will try to send the message in clear,
789 unless the host is in hosts_require_tls (tested below). */
791 if (!smtps && !smtp_read_response(&inblock, buffer2, sizeof(buffer2), '2',
792 ob->command_timeout))
796 || buffer2[0] == '4' && !ob->tls_tempfail_tryclear
799 Ustrncpy(responsebuffer, buffer2, sizeof(responsebuffer));
801 goto RESPONSE_FAILED;
805 /* STARTTLS accepted or ssl-on-connect: try to negotiate a TLS session. */
808 int oldtimeout = ob->command_timeout;
811 ob->command_timeout = callout;
812 rc = tls_client_start(inblock.sock, host, addr, addr->transport
813 # ifdef EXPERIMENTAL_DANE
814 , dane ? &tlsa_dnsa : NULL
817 ob->command_timeout = oldtimeout;
819 /* TLS negotiation failed; give an error. Try in clear on a new
820 connection, if the options permit it for this host. */
825 (void)close(inblock.sock);
826 # ifndef DISABLE_EVENT
827 (void) event_raise(addr->transport->event_action,
828 US"tcp:close", NULL);
830 if ( ob->tls_tempfail_tryclear
832 && verify_check_given_host(&ob->hosts_require_tls, host) != OK
835 log_write(0, LOG_MAIN, "TLS session failure:"
836 " delivering unencrypted to %s [%s] (not in hosts_require_tls)",
837 host->name, host->address);
839 goto tls_retry_connection;
843 /*save_errno = ERRNO_TLSFAILURE;*/
844 /*message = US"failure while setting up TLS session";*/
850 /* TLS session is set up. Copy info for logging. */
851 addr->cipher = tls_out.cipher;
852 addr->peerdn = tls_out.peerdn;
854 /* For SMTPS we need to wait for the initial OK response, then do HELO. */
856 goto smtps_redo_greeting;
858 /* For STARTTLS we need to redo EHLO */
863 /* If the host is required to use a secure channel, ensure that we have one. */
864 if (tls_out.active < 0)
866 # ifdef EXPERIMENTAL_DANE
869 verify_check_given_host(&ob->hosts_require_tls, host) == OK
872 /*save_errno = ERRNO_TLSREQUIRED;*/
873 log_write(0, LOG_MAIN,
874 "H=%s [%s]: a TLS session is required for this host, but %s",
875 host->name, host->address,
876 peer_offered & PEER_OFFERED_TLS
877 ? "an attempt to start TLS failed"
878 : "the server did not offer TLS support");
883 #endif /*SUPPORT_TLS*/
885 done = TRUE; /* so far so good; have response to HELO */
887 /* For now, transport_filter by cutthrough-delivery is not supported */
888 /* Need proper integration with the proper transport mechanism. */
889 if (cutthrough.delivery)
894 if (addr->transport->filter_command)
896 cutthrough.delivery = FALSE;
897 HDEBUG(D_acl|D_v) debug_printf("Cutthrough cancelled by presence of transport filter\n");
900 else if ((s = ob->dkim.dkim_domain) && (s = expand_string(s)) && *s)
902 cutthrough.delivery = FALSE;
903 HDEBUG(D_acl|D_v) debug_printf("Cutthrough cancelled by presence of DKIM signing\n");
912 /* Clear down of the TLS, SMTP and TCP layers on error is handled below. */
914 /* Failure to accept HELO is cached; this blocks the whole domain for all
915 senders. I/O errors and defer responses are not cached. */
919 *failure_ptr = US"mail"; /* At or before MAIL */
920 if (errno == 0 && responsebuffer[0] == '5')
922 setflag(addr, af_verify_nsfail);
923 new_domain_record.result = ccache_reject;
928 else if ( addr->prop.utf8_msg
929 && !addr->prop.utf8_downcvt
930 && !(peer_offered & PEER_OFFERED_UTF8)
933 HDEBUG(D_acl|D_v) debug_printf("utf8 required but not offered\n");
934 errno = ERRNO_UTF8_FWD;
935 setflag(addr, af_verify_nsfail);
938 else if ( addr->prop.utf8_msg
939 && (addr->prop.utf8_downcvt || !(peer_offered & PEER_OFFERED_UTF8))
940 && (setflag(addr, af_utf8_downcvt),
941 from_address = string_address_utf8_to_alabel(from_address,
946 errno = ERRNO_EXPANDFAIL;
947 setflag(addr, af_verify_nsfail);
952 /* If we haven't authenticated, but are required to, give up. */
955 else done = smtp_auth(responsebuffer, sizeof(responsebuffer),
956 addr, host, ob, esmtp, &inblock, &outblock) == OK &&
958 /* Copy AUTH info for logging */
959 ( (addr->authenticator = client_authenticator),
960 (addr->auth_id = client_authenticated_id),
962 /* Build a mail-AUTH string (re-using responsebuffer for convenience */
963 !smtp_mail_auth_str(responsebuffer, sizeof(responsebuffer), addr, ob)
966 ( (addr->auth_sndr = client_authenticated_sender),
968 /* Send the MAIL command */
969 (smtp_write_command(&outblock, FALSE,
971 addr->prop.utf8_msg && !addr->prop.utf8_downcvt
972 ? "MAIL FROM:<%s>%s%s SMTPUTF8\r\n"
975 "MAIL FROM:<%s>%s%s\r\n",
976 from_address, responsebuffer, size_str) >= 0)
979 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
982 deliver_host = deliver_host_address = NULL;
983 deliver_domain = save_deliver_domain;
985 /* If the host does not accept MAIL FROM:<>, arrange to cache this
986 information, but again, don't record anything for an I/O error or a defer. Do
987 not cache rejections of MAIL when a non-empty sender has been used, because
988 that blocks the whole domain for all senders. */
992 *failure_ptr = US"mail"; /* At or before MAIL */
993 if (errno == 0 && responsebuffer[0] == '5')
995 setflag(addr, af_verify_nsfail);
996 if (from_address[0] == 0)
997 new_domain_record.result = ccache_reject_mfnull;
1001 /* Otherwise, proceed to check a "random" address (if required), then the
1002 given address, and the postmaster address (if required). Between each check,
1003 issue RSET, because some servers accept only one recipient after MAIL
1006 Before doing this, set the result in the domain cache record to "accept",
1007 unless its previous value was ccache_reject_mfnull. In that case, the domain
1008 rejects MAIL FROM:<> and we want to continue to remember that. When that is
1009 the case, we have got here only in the case of a recipient verification with
1010 a non-null sender. */
1014 const uschar * rcpt_domain = addr->domain;
1017 uschar * errstr = NULL;
1018 if ( testflag(addr, af_utf8_downcvt)
1019 && (rcpt_domain = string_domain_utf8_to_alabel(rcpt_domain,
1023 addr->message = errstr;
1024 errno = ERRNO_EXPANDFAIL;
1025 setflag(addr, af_verify_nsfail);
1027 rcpt_domain = US""; /*XXX errorhandling! */
1031 new_domain_record.result =
1032 (old_domain_cache_result == ccache_reject_mfnull)?
1033 ccache_reject_mfnull: ccache_accept;
1035 /* Do the random local part check first */
1037 if (random_local_part != NULL)
1039 uschar randombuffer[1024];
1041 smtp_write_command(&outblock, FALSE,
1042 "RCPT TO:<%.1000s@%.1000s>\r\n", random_local_part,
1043 rcpt_domain) >= 0 &&
1044 smtp_read_response(&inblock, randombuffer,
1045 sizeof(randombuffer), '2', callout);
1047 /* Remember when we last did a random test */
1049 new_domain_record.random_stamp = time(NULL);
1051 /* If accepted, we aren't going to do any further tests below. */
1054 new_domain_record.random_result = ccache_accept;
1056 /* Otherwise, cache a real negative response, and get back to the right
1057 state to send RCPT. Unless there's some problem such as a dropped
1058 connection, we expect to succeed, because the commands succeeded above.
1059 However, some servers drop the connection after responding to an
1060 invalid recipient, so on (any) error we drop and remake the connection.
1063 else if (errno == 0)
1065 /* This would be ok for 1st rcpt a cutthrough, but no way to
1066 handle a subsequent. So refuse to support any */
1067 cancel_cutthrough_connection("random-recipient");
1069 if (randombuffer[0] == '5')
1070 new_domain_record.random_result = ccache_reject;
1073 smtp_write_command(&outblock, FALSE, "RSET\r\n") >= 0 &&
1074 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
1077 smtp_write_command(&outblock, FALSE,
1079 addr->prop.utf8_msg && !addr->prop.utf8_downcvt
1080 ? "MAIL FROM:<%s> SMTPUTF8\r\n"
1083 "MAIL FROM:<%s>\r\n",
1084 from_address) >= 0 &&
1085 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
1091 debug_printf("problem after random/rset/mfrom; reopen conn\n");
1092 random_local_part = NULL;
1094 tls_close(FALSE, TRUE);
1096 (void)close(inblock.sock);
1097 #ifndef DISABLE_EVENT
1098 (void) event_raise(addr->transport->event_action,
1099 US"tcp:close", NULL);
1101 goto tls_retry_connection;
1104 else done = FALSE; /* Some timeout/connection problem */
1105 } /* Random check */
1107 /* If the host is accepting all local parts, as determined by the "random"
1108 check, we don't need to waste time doing any further checking. */
1110 if (new_domain_record.random_result != ccache_accept && done)
1112 /* Get the rcpt_include_affixes flag from the transport if there is one,
1113 but assume FALSE if there is not. */
1115 uschar * rcpt = transport_rcpt_address(addr,
1116 addr->transport ? addr->transport->rcpt_include_affixes : FALSE);
1119 /*XXX should the conversion be moved into transport_rcpt_address() ? */
1120 uschar * dummy_errstr = NULL;
1121 if ( testflag(addr, af_utf8_downcvt)
1122 && (rcpt = string_address_utf8_to_alabel(rcpt, &dummy_errstr),
1126 errno = ERRNO_EXPANDFAIL;
1127 *failure_ptr = US"recipient";
1134 smtp_write_command(&outblock, FALSE, "RCPT TO:<%.1000s>\r\n",
1136 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
1140 new_address_record.result = ccache_accept;
1141 else if (errno == 0 && responsebuffer[0] == '5')
1143 *failure_ptr = US"recipient";
1144 new_address_record.result = ccache_reject;
1147 /* Do postmaster check if requested; if a full check is required, we
1148 check for RCPT TO:<postmaster> (no domain) in accordance with RFC 821. */
1150 if (done && pm_mailfrom != NULL)
1152 /* Could possibly shift before main verify, just above, and be ok
1153 for cutthrough. But no way to handle a subsequent rcpt, so just
1155 cancel_cutthrough_connection("postmaster verify");
1156 HDEBUG(D_acl|D_v) debug_printf("Cutthrough cancelled by presence of postmaster verify\n");
1159 smtp_write_command(&outblock, FALSE, "RSET\r\n") >= 0 &&
1160 smtp_read_response(&inblock, responsebuffer,
1161 sizeof(responsebuffer), '2', callout) &&
1163 smtp_write_command(&outblock, FALSE,
1164 "MAIL FROM:<%s>\r\n", pm_mailfrom) >= 0 &&
1165 smtp_read_response(&inblock, responsebuffer,
1166 sizeof(responsebuffer), '2', callout) &&
1168 /* First try using the current domain */
1171 smtp_write_command(&outblock, FALSE,
1172 "RCPT TO:<postmaster@%.1000s>\r\n", rcpt_domain) >= 0 &&
1173 smtp_read_response(&inblock, responsebuffer,
1174 sizeof(responsebuffer), '2', callout)
1179 /* If that doesn't work, and a full check is requested,
1180 try without the domain. */
1183 (options & vopt_callout_fullpm) != 0 &&
1184 smtp_write_command(&outblock, FALSE,
1185 "RCPT TO:<postmaster>\r\n") >= 0 &&
1186 smtp_read_response(&inblock, responsebuffer,
1187 sizeof(responsebuffer), '2', callout)
1190 /* Sort out the cache record */
1192 new_domain_record.postmaster_stamp = time(NULL);
1195 new_domain_record.postmaster_result = ccache_accept;
1196 else if (errno == 0 && responsebuffer[0] == '5')
1198 *failure_ptr = US"postmaster";
1199 setflag(addr, af_verify_pmfail);
1200 new_domain_record.postmaster_result = ccache_reject;
1203 } /* Random not accepted */
1204 } /* MAIL FROM: accepted */
1206 /* For any failure of the main check, other than a negative response, we just
1207 close the connection and carry on. We can identify a negative response by the
1208 fact that errno is zero. For I/O errors it will be non-zero
1210 Set up different error texts for logging and for sending back to the caller
1211 as an SMTP response. Log in all cases, using a one-line format. For sender
1212 callouts, give a full response to the caller, but for recipient callouts,
1213 don't give the IP address because this may be an internal host whose identity
1214 is not to be widely broadcast. */
1218 if (errno == ETIMEDOUT)
1220 HDEBUG(D_verify) debug_printf("SMTP timeout\n");
1224 else if (errno == ERRNO_UTF8_FWD)
1226 extern int acl_where; /* src/acl.c */
1228 addr->message = string_sprintf(
1229 "response to \"%s\" from %s [%s] did not include SMTPUTF8",
1230 big_buffer, host->name, host->address);
1231 addr->user_message = acl_where == ACL_WHERE_RCPT
1232 ? US"533 mailbox name not allowed"
1233 : US"550 mailbox unavailable";
1238 else if (errno == 0)
1240 if (*responsebuffer == 0) Ustrcpy(responsebuffer, US"connection dropped");
1243 string_sprintf("response to \"%s\" from %s [%s] was: %s",
1244 big_buffer, host->name, host->address,
1245 string_printing(responsebuffer));
1247 addr->user_message = options & vopt_is_recipient
1248 ? string_sprintf("Callout verification failed:\n%s", responsebuffer)
1249 : string_sprintf("Called: %s\nSent: %s\nResponse: %s",
1250 host->address, big_buffer, responsebuffer);
1252 /* Hard rejection ends the process */
1254 if (responsebuffer[0] == '5') /* Address rejected */
1262 /* End the SMTP conversation and close the connection. */
1264 /* Cutthrough - on a successfull connect and recipient-verify with
1265 use-sender and we are 1st rcpt and have no cutthrough conn so far
1266 here is where we want to leave the conn open */
1267 if ( cutthrough.delivery
1271 && (options & (vopt_callout_recipsender|vopt_callout_recippmaster|vopt_success_on_redirect))
1272 == vopt_callout_recipsender
1273 && !random_local_part
1275 && cutthrough.fd < 0
1279 HDEBUG(D_acl|D_v) debug_printf("holding verify callout open for cutthrough delivery\n");
1281 cutthrough.fd = outblock.sock; /* We assume no buffer in use in the outblock */
1282 cutthrough.nrcpt = 1;
1283 cutthrough.interface = interface;
1284 cutthrough.host = *host;
1285 cutthrough.addr = *addr; /* Save the address_item for later logging */
1286 cutthrough.addr.next = NULL;
1287 cutthrough.addr.host_used = &cutthrough.host;
1289 *(cutthrough.addr.parent = store_get(sizeof(address_item))) =
1291 ctblock.buffer = ctbuffer;
1292 ctblock.buffersize = sizeof(ctbuffer);
1293 ctblock.ptr = ctbuffer;
1294 /* ctblock.cmd_count = 0; ctblock.authenticating = FALSE; */
1295 ctblock.sock = cutthrough.fd;
1299 /* Ensure no cutthrough on multiple address verifies */
1300 if (options & vopt_callout_recipsender)
1301 cancel_cutthrough_connection("not usable for cutthrough");
1303 (void) smtp_write_command(&outblock, FALSE, "QUIT\r\n");
1306 tls_close(FALSE, TRUE);
1308 (void)close(inblock.sock);
1309 #ifndef DISABLE_EVENT
1310 (void) event_raise(addr->transport->event_action, US"tcp:close", NULL);
1314 } /* Loop through all hosts, while !done */
1317 /* If we get here with done == TRUE, a successful callout happened, and yield
1318 will be set OK or FAIL according to the response to the RCPT command.
1319 Otherwise, we looped through the hosts but couldn't complete the business.
1320 However, there may be domain-specific information to cache in both cases.
1322 The value of the result field in the new_domain record is ccache_unknown if
1323 there was an error before or with MAIL FROM:, and errno was not zero,
1324 implying some kind of I/O error. We don't want to write the cache in that case.
1325 Otherwise the value is ccache_accept, ccache_reject, or ccache_reject_mfnull. */
1327 if ( !(options & vopt_callout_no_cache)
1328 && new_domain_record.result != ccache_unknown)
1330 if ((dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE))
1333 HDEBUG(D_verify) debug_printf("callout cache: not available\n");
1337 (void)dbfn_write(dbm_file, addr->domain, &new_domain_record,
1338 (int)sizeof(dbdata_callout_cache));
1339 HDEBUG(D_verify) debug_printf("wrote callout cache domain record for %s:\n"
1340 " result=%d postmaster=%d random=%d\n",
1342 new_domain_record.result,
1343 new_domain_record.postmaster_result,
1344 new_domain_record.random_result);
1348 /* If a definite result was obtained for the callout, cache it unless caching
1353 if ( !(options & vopt_callout_no_cache)
1354 && new_address_record.result != ccache_unknown)
1357 dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE);
1360 HDEBUG(D_verify) debug_printf("no callout cache available\n");
1364 (void)dbfn_write(dbm_file, address_key, &new_address_record,
1365 (int)sizeof(dbdata_callout_cache_address));
1366 HDEBUG(D_verify) debug_printf("wrote %s callout cache address record for %s\n",
1367 new_address_record.result == ccache_accept ? "positive" : "negative",
1373 /* Failure to connect to any host, or any response other than 2xx or 5xx is a
1374 temporary error. If there was only one host, and a response was received, leave
1375 it alone if supplying details. Otherwise, give a generic response. */
1379 uschar * dullmsg = string_sprintf("Could not complete %s verify callout",
1380 options & vopt_is_recipient ? "recipient" : "sender");
1383 if (host_list->next || !addr->message)
1384 addr->message = dullmsg;
1386 addr->user_message = smtp_return_error_details
1387 ? string_sprintf("%s for <%s>.\n"
1388 "The mail server(s) for the domain may be temporarily unreachable, or\n"
1389 "they may be permanently unreachable from this server. In the latter case,\n%s",
1390 dullmsg, addr->address,
1391 options & vopt_is_recipient
1392 ? "the address will never be accepted."
1393 : "you need to change the address or create an MX record for its domain\n"
1394 "if it is supposed to be generally accessible from the Internet.\n"
1395 "Talk to your mail administrator for details.")
1398 /* Force a specific error code */
1400 addr->basic_errno = ERRNO_CALLOUTDEFER;
1403 /* Come here from within the cache-reading code on fast-track exit. */
1406 if (dbm_file) dbfn_close(dbm_file);
1412 /* Called after recipient-acl to get a cutthrough connection open when
1413 one was requested and a recipient-verify wasn't subsequently done.
1416 open_cutthrough_connection( address_item * addr )
1421 /* Use a recipient-verify-callout to set up the cutthrough connection. */
1422 /* We must use a copy of the address for verification, because it might
1426 HDEBUG(D_acl) debug_printf("----------- %s cutthrough setup ------------\n",
1427 rcpt_count > 1 ? "more" : "start");
1428 rc = verify_address(&addr2, NULL,
1429 vopt_is_recipient | vopt_callout_recipsender | vopt_callout_no_cache,
1430 CUTTHROUGH_CMD_TIMEOUT, -1, -1,
1432 addr->message = addr2.message;
1433 addr->user_message = addr2.user_message;
1434 HDEBUG(D_acl) debug_printf("----------- end cutthrough setup ------------\n");
1440 /* Send given number of bytes from the buffer */
1442 cutthrough_send(int n)
1444 if(cutthrough.fd < 0)
1449 (tls_out.active == cutthrough.fd) ? tls_write(FALSE, ctblock.buffer, n) :
1451 send(cutthrough.fd, ctblock.buffer, n, 0) > 0
1454 transport_count += n;
1455 ctblock.ptr= ctblock.buffer;
1459 HDEBUG(D_transport|D_acl) debug_printf("cutthrough_send failed: %s\n", strerror(errno));
1466 _cutthrough_puts(uschar * cp, int n)
1470 if(ctblock.ptr >= ctblock.buffer+ctblock.buffersize)
1471 if(!cutthrough_send(ctblock.buffersize))
1474 *ctblock.ptr++ = *cp++;
1479 /* Buffered output of counted data block. Return boolean success */
1481 cutthrough_puts(uschar * cp, int n)
1483 if (cutthrough.fd < 0) return TRUE;
1484 if (_cutthrough_puts(cp, n)) return TRUE;
1485 cancel_cutthrough_connection("transmit failed");
1491 _cutthrough_flush_send(void)
1493 int n= ctblock.ptr-ctblock.buffer;
1496 if(!cutthrough_send(n))
1502 /* Send out any bufferred output. Return boolean success. */
1504 cutthrough_flush_send(void)
1506 if (_cutthrough_flush_send()) return TRUE;
1507 cancel_cutthrough_connection("transmit failed");
1513 cutthrough_put_nl(void)
1515 return cutthrough_puts(US"\r\n", 2);
1519 /* Get and check response from cutthrough target */
1521 cutthrough_response(char expect, uschar ** copy)
1523 smtp_inblock inblock;
1524 uschar inbuffer[4096];
1525 uschar responsebuffer[4096];
1527 inblock.buffer = inbuffer;
1528 inblock.buffersize = sizeof(inbuffer);
1529 inblock.ptr = inbuffer;
1530 inblock.ptrend = inbuffer;
1531 inblock.sock = cutthrough.fd;
1532 /* this relies on (inblock.sock == tls_out.active) */
1533 if(!smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer), expect, CUTTHROUGH_DATA_TIMEOUT))
1534 cancel_cutthrough_connection("target timeout on read");
1539 *copy = cp = string_copy(responsebuffer);
1540 /* Trim the trailing end of line */
1541 cp += Ustrlen(responsebuffer);
1542 if(cp > *copy && cp[-1] == '\n') *--cp = '\0';
1543 if(cp > *copy && cp[-1] == '\r') *--cp = '\0';
1546 return responsebuffer[0];
1550 /* Negotiate dataphase with the cutthrough target, returning success boolean */
1552 cutthrough_predata(void)
1554 if(cutthrough.fd < 0)
1557 HDEBUG(D_transport|D_acl|D_v) debug_printf(" SMTP>> DATA\n");
1558 cutthrough_puts(US"DATA\r\n", 6);
1559 cutthrough_flush_send();
1561 /* Assume nothing buffered. If it was it gets ignored. */
1562 return cutthrough_response('3', NULL) == '3';
1566 /* fd and tctx args only to match write_chunk() */
1568 cutthrough_write_chunk(int fd, transport_ctx * tctx, uschar * s, int len)
1571 while(s && (s2 = Ustrchr(s, '\n')))
1573 if(!cutthrough_puts(s, s2-s) || !cutthrough_put_nl())
1581 /* Buffered send of headers. Return success boolean. */
1582 /* Expands newlines to wire format (CR,NL). */
1583 /* Also sends header-terminating blank line. */
1585 cutthrough_headers_send(void)
1589 if(cutthrough.fd < 0)
1592 /* We share a routine with the mainline transport to handle header add/remove/rewrites,
1593 but having a separate buffered-output function (for now)
1595 HDEBUG(D_acl) debug_printf("----------- start cutthrough headers send -----------\n");
1597 tctx.tblock = cutthrough.addr.transport;
1598 tctx.addr = &cutthrough.addr;
1599 tctx.check_string = US".";
1600 tctx.escape_string = US"..";
1601 tctx.options = topt_use_crlf;
1603 if (!transport_headers_send(cutthrough.fd, &tctx, &cutthrough_write_chunk))
1606 HDEBUG(D_acl) debug_printf("----------- done cutthrough headers send ------------\n");
1612 close_cutthrough_connection(const char * why)
1614 if(cutthrough.fd >= 0)
1616 /* We could be sending this after a bunch of data, but that is ok as
1617 the only way to cancel the transfer in dataphase is to drop the tcp
1618 conn before the final dot.
1620 ctblock.ptr = ctbuffer;
1621 HDEBUG(D_transport|D_acl|D_v) debug_printf(" SMTP>> QUIT\n");
1622 _cutthrough_puts(US"QUIT\r\n", 6); /* avoid recursion */
1623 _cutthrough_flush_send();
1624 /* No wait for response */
1627 tls_close(FALSE, TRUE);
1629 (void)close(cutthrough.fd);
1631 HDEBUG(D_acl) debug_printf("----------- cutthrough shutdown (%s) ------------\n", why);
1633 ctblock.ptr = ctbuffer;
1637 cancel_cutthrough_connection(const char * why)
1639 close_cutthrough_connection(why);
1640 cutthrough.delivery = FALSE;
1646 /* Have senders final-dot. Send one to cutthrough target, and grab the response.
1647 Log an OK response as a transmission.
1648 Close the connection.
1649 Return smtp response-class digit.
1652 cutthrough_finaldot(void)
1655 address_item * addr;
1656 HDEBUG(D_transport|D_acl|D_v) debug_printf(" SMTP>> .\n");
1658 /* Assume data finshed with new-line */
1659 if( !cutthrough_puts(US".", 1)
1660 || !cutthrough_put_nl()
1661 || !cutthrough_flush_send()
1663 return cutthrough.addr.message;
1665 res = cutthrough_response('2', &cutthrough.addr.message);
1666 for (addr = &cutthrough.addr; addr; addr = addr->next)
1668 addr->message = cutthrough.addr.message;
1672 delivery_log(LOG_MAIN, addr, (int)'>', NULL);
1673 close_cutthrough_connection("delivered");
1677 delivery_log(LOG_MAIN, addr, 0,
1678 US"tmp-reject from cutthrough after DATA:");
1682 delivery_log(LOG_MAIN|LOG_REJECT, addr, 0,
1683 US"rejected after DATA:");
1690 return cutthrough.addr.message;
1695 /*************************************************
1696 * Copy error to toplevel address *
1697 *************************************************/
1699 /* This function is used when a verify fails or defers, to ensure that the
1700 failure or defer information is in the original toplevel address. This applies
1701 when an address is redirected to a single new address, and the failure or
1702 deferral happens to the child address.
1705 vaddr the verify address item
1706 addr the final address item
1709 Returns: the value of YIELD
1713 copy_error(address_item *vaddr, address_item *addr, int yield)
1717 vaddr->message = addr->message;
1718 vaddr->user_message = addr->user_message;
1719 vaddr->basic_errno = addr->basic_errno;
1720 vaddr->more_errno = addr->more_errno;
1721 vaddr->prop.address_data = addr->prop.address_data;
1722 copyflag(vaddr, addr, af_pass_message);
1730 /**************************************************
1731 * printf that automatically handles TLS if needed *
1732 ***************************************************/
1734 /* This function is used by verify_address() as a substitute for all fprintf()
1735 calls; a direct fprintf() will not produce output in a TLS SMTP session, such
1736 as a response to an EXPN command. smtp_in.c makes smtp_printf available but
1737 that assumes that we always use the smtp_out FILE* when not using TLS or the
1738 ssl buffer when we are. Instead we take a FILE* parameter and check to see if
1739 that is smtp_out; if so, smtp_printf() with TLS support, otherwise regular
1743 f the candidate FILE* to write to
1744 format format string
1745 ... optional arguments
1751 static void PRINTF_FUNCTION(2,3)
1752 respond_printf(FILE *f, const char *format, ...)
1756 va_start(ap, format);
1757 if (smtp_out && (f == smtp_out))
1758 smtp_vprintf(format, ap);
1760 vfprintf(f, format, ap);
1766 /*************************************************
1767 * Verify an email address *
1768 *************************************************/
1770 /* This function is used both for verification (-bv and at other times) and
1771 address testing (-bt), which is indicated by address_test_mode being set.
1774 vaddr contains the address to verify; the next field in this block
1776 f if not NULL, write the result to this file
1777 options various option bits:
1778 vopt_fake_sender => this sender verify is not for the real
1779 sender (it was verify=sender=xxxx or an address from a
1780 header line) - rewriting must not change sender_address
1781 vopt_is_recipient => this is a recipient address, otherwise
1782 it's a sender address - this affects qualification and
1783 rewriting and messages from callouts
1784 vopt_qualify => qualify an unqualified address; else error
1785 vopt_expn => called from SMTP EXPN command
1786 vopt_success_on_redirect => when a new address is generated
1787 the verification instantly succeeds
1789 These ones are used by do_callout() -- the options variable
1792 vopt_callout_fullpm => if postmaster check, do full one
1793 vopt_callout_no_cache => don't use callout cache
1794 vopt_callout_random => do the "random" thing
1795 vopt_callout_recipsender => use real sender for recipient
1796 vopt_callout_recippmaster => use postmaster for recipient
1798 callout if > 0, specifies that callout is required, and gives timeout
1799 for individual commands
1800 callout_overall if > 0, gives overall timeout for the callout function;
1801 if < 0, a default is used (see do_callout())
1802 callout_connect the connection timeout for callouts
1803 se_mailfrom when callout is requested to verify a sender, use this
1804 in MAIL FROM; NULL => ""
1805 pm_mailfrom when callout is requested, if non-NULL, do the postmaster
1806 thing and use this as the sender address (may be "")
1808 routed if not NULL, set TRUE if routing succeeded, so we can
1809 distinguish between routing failed and callout failed
1811 Returns: OK address verified
1812 FAIL address failed to verify
1813 DEFER can't tell at present
1817 verify_address(address_item *vaddr, FILE *f, int options, int callout,
1818 int callout_overall, int callout_connect, uschar *se_mailfrom,
1819 uschar *pm_mailfrom, BOOL *routed)
1822 BOOL full_info = (f == NULL)? FALSE : (debug_selector != 0);
1823 BOOL expn = (options & vopt_expn) != 0;
1824 BOOL success_on_redirect = (options & vopt_success_on_redirect) != 0;
1827 int verify_type = expn? v_expn :
1828 address_test_mode? v_none :
1829 options & vopt_is_recipient? v_recipient : v_sender;
1830 address_item *addr_list;
1831 address_item *addr_new = NULL;
1832 address_item *addr_remote = NULL;
1833 address_item *addr_local = NULL;
1834 address_item *addr_succeed = NULL;
1835 uschar **failure_ptr = options & vopt_is_recipient
1836 ? &recipient_verify_failure : &sender_verify_failure;
1837 uschar *ko_prefix, *cr;
1838 uschar *address = vaddr->address;
1839 uschar *save_sender;
1840 uschar null_sender[] = { 0 }; /* Ensure writeable memory */
1842 /* Clear, just in case */
1844 *failure_ptr = NULL;
1846 /* Set up a prefix and suffix for error message which allow us to use the same
1847 output statements both in EXPN mode (where an SMTP response is needed) and when
1848 debugging with an output file. */
1852 ko_prefix = US"553 ";
1855 else ko_prefix = cr = US"";
1857 /* Add qualify domain if permitted; otherwise an unqualified address fails. */
1859 if (parse_find_at(address) == NULL)
1861 if ((options & vopt_qualify) == 0)
1864 respond_printf(f, "%sA domain is required for \"%s\"%s\n",
1865 ko_prefix, address, cr);
1866 *failure_ptr = US"qualify";
1869 address = rewrite_address_qualify(address, options & vopt_is_recipient);
1874 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
1875 debug_printf("%s %s\n", address_test_mode? "Testing" : "Verifying", address);
1878 /* Rewrite and report on it. Clear the domain and local part caches - these
1879 may have been set by domains and local part tests during an ACL. */
1881 if (global_rewrite_rules != NULL)
1883 uschar *old = address;
1884 address = rewrite_address(address, options & vopt_is_recipient, FALSE,
1885 global_rewrite_rules, rewrite_existflags);
1888 for (i = 0; i < (MAX_NAMED_LIST * 2)/32; i++) vaddr->localpart_cache[i] = 0;
1889 for (i = 0; i < (MAX_NAMED_LIST * 2)/32; i++) vaddr->domain_cache[i] = 0;
1890 if (f != NULL && !expn) fprintf(f, "Address rewritten as: %s\n", address);
1894 /* If this is the real sender address, we must update sender_address at
1895 this point, because it may be referred to in the routers. */
1897 if ((options & (vopt_fake_sender|vopt_is_recipient)) == 0)
1898 sender_address = address;
1900 /* If the address was rewritten to <> no verification can be done, and we have
1901 to return OK. This rewriting is permitted only for sender addresses; for other
1902 addresses, such rewriting fails. */
1904 if (address[0] == 0) return OK;
1906 /* Flip the legacy TLS-related variables over to the outbound set in case
1907 they're used in the context of a transport used by verification. Reset them
1908 at exit from this routine (so no returns allowed from here on). */
1910 tls_modify_variables(&tls_out);
1912 /* Save a copy of the sender address for re-instating if we change it to <>
1913 while verifying a sender address (a nice bit of self-reference there). */
1915 save_sender = sender_address;
1917 /* Observability variable for router/transport use */
1919 verify_mode = options & vopt_is_recipient ? US"R" : US"S";
1921 /* Update the address structure with the possibly qualified and rewritten
1922 address. Set it up as the starting address on the chain of new addresses. */
1924 vaddr->address = address;
1927 /* We need a loop, because an address can generate new addresses. We must also
1928 cope with generated pipes and files at the top level. (See also the code and
1929 comment in deliver.c.) However, it is usually the case that the router for
1930 user's .forward files has its verify flag turned off.
1932 If an address generates more than one child, the loop is used only when
1933 full_info is set, and this can only be set locally. Remote enquiries just get
1934 information about the top level address, not anything that it generated. */
1939 address_item *addr = addr_new;
1941 addr_new = addr->next;
1946 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
1947 debug_printf("Considering %s\n", addr->address);
1950 /* Handle generated pipe, file or reply addresses. We don't get these
1951 when handling EXPN, as it does only one level of expansion. */
1953 if (testflag(addr, af_pfr))
1960 if (addr->address[0] == '>')
1962 allow = testflag(addr, af_allow_reply);
1963 fprintf(f, "%s -> mail %s", addr->parent->address, addr->address + 1);
1967 allow = (addr->address[0] == '|')?
1968 testflag(addr, af_allow_pipe) : testflag(addr, af_allow_file);
1969 fprintf(f, "%s -> %s", addr->parent->address, addr->address);
1972 if (addr->basic_errno == ERRNO_BADTRANSPORT)
1973 fprintf(f, "\n*** Error in setting up pipe, file, or autoreply:\n"
1974 "%s\n", addr->message);
1976 fprintf(f, "\n transport = %s\n", addr->transport->name);
1978 fprintf(f, " *** forbidden ***\n");
1983 /* Just in case some router parameter refers to it. */
1985 return_path = addr->prop.errors_address
1986 ? addr->prop.errors_address : sender_address;
1988 /* Split the address into domain and local part, handling the %-hack if
1989 necessary, and then route it. While routing a sender address, set
1990 $sender_address to <> because that is what it will be if we were trying to
1991 send a bounce to the sender. */
1993 if (routed) *routed = FALSE;
1994 if ((rc = deliver_split_address(addr)) == OK)
1996 if (!(options & vopt_is_recipient)) sender_address = null_sender;
1997 rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
1998 &addr_succeed, verify_type);
1999 sender_address = save_sender; /* Put back the real sender */
2002 /* If routing an address succeeded, set the flag that remembers, for use when
2003 an ACL cached a sender verify (in case a callout fails). Then if routing set
2004 up a list of hosts or the transport has a host list, and the callout option
2005 is set, and we aren't in a host checking run, do the callout verification,
2006 and set another flag that notes that a callout happened. */
2010 if (routed) *routed = TRUE;
2013 transport_instance * tp;
2014 host_item * host_list = addr->host_list;
2016 /* Make up some data for use in the case where there is no remote
2019 transport_feedback tf = {
2020 NULL, /* interface (=> any) */
2021 US"smtp", /* port */
2022 US"smtp", /* protocol */
2024 US"$smtp_active_hostname", /* helo_data */
2025 FALSE, /* hosts_override */
2026 FALSE, /* hosts_randomize */
2027 FALSE, /* gethostbyname */
2028 TRUE, /* qualify_single */
2029 FALSE /* search_parents */
2032 /* If verification yielded a remote transport, we want to use that
2033 transport's options, so as to mimic what would happen if we were really
2034 sending a message to this address. */
2036 if ((tp = addr->transport) && !tp->info->local)
2038 (void)(tp->setup)(tp, addr, &tf, 0, 0, NULL);
2040 /* If the transport has hosts and the router does not, or if the
2041 transport is configured to override the router's hosts, we must build a
2042 host list of the transport's hosts, and find the IP addresses */
2044 if (tf.hosts && (!host_list || tf.hosts_override))
2047 const uschar *save_deliver_domain = deliver_domain;
2048 uschar *save_deliver_localpart = deliver_localpart;
2050 host_list = NULL; /* Ignore the router's hosts */
2052 deliver_domain = addr->domain;
2053 deliver_localpart = addr->local_part;
2054 s = expand_string(tf.hosts);
2055 deliver_domain = save_deliver_domain;
2056 deliver_localpart = save_deliver_localpart;
2060 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand list of hosts "
2061 "\"%s\" in %s transport for callout: %s", tf.hosts,
2062 tp->name, expand_string_message);
2067 host_item *host, *nexthost;
2068 host_build_hostlist(&host_list, s, tf.hosts_randomize);
2070 /* Just ignore failures to find a host address. If we don't manage
2071 to find any addresses, the callout will defer. Note that more than
2072 one address may be found for a single host, which will result in
2073 additional host items being inserted into the chain. Hence we must
2074 save the next host first. */
2076 flags = HOST_FIND_BY_A;
2077 if (tf.qualify_single) flags |= HOST_FIND_QUALIFY_SINGLE;
2078 if (tf.search_parents) flags |= HOST_FIND_SEARCH_PARENTS;
2080 for (host = host_list; host; host = nexthost)
2082 nexthost = host->next;
2083 if (tf.gethostbyname ||
2084 string_is_ip_address(host->name, NULL) != 0)
2085 (void)host_find_byname(host, NULL, flags, NULL, TRUE);
2088 dnssec_domains * dnssec_domains = NULL;
2089 if (Ustrcmp(tp->driver_name, "smtp") == 0)
2091 smtp_transport_options_block * ob =
2092 (smtp_transport_options_block *) tp->options_block;
2093 dnssec_domains = &ob->dnssec;
2096 (void)host_find_bydns(host, NULL, flags, NULL, NULL, NULL,
2097 dnssec_domains, NULL, NULL);
2104 /* Can only do a callout if we have at least one host! If the callout
2105 fails, it will have set ${sender,recipient}_verify_failure. */
2109 HDEBUG(D_verify) debug_printf("Attempting full verification using callout\n");
2110 if (host_checking && !host_checking_callout)
2113 debug_printf("... callout omitted by default when host testing\n"
2114 "(Use -bhc if you want the callouts to happen.)\n");
2119 deliver_set_expansions(addr);
2121 rc = do_callout(addr, host_list, &tf, callout, callout_overall,
2122 callout_connect, options, se_mailfrom, pm_mailfrom);
2127 HDEBUG(D_verify) debug_printf("Cannot do callout: neither router nor "
2128 "transport provided a host list\n");
2133 /* Otherwise, any failure is a routing failure */
2135 else *failure_ptr = US"route";
2137 /* A router may return REROUTED if it has set up a child address as a result
2138 of a change of domain name (typically from widening). In this case we always
2139 want to continue to verify the new child. */
2141 if (rc == REROUTED) continue;
2143 /* Handle hard failures */
2150 address_item *p = addr->parent;
2152 respond_printf(f, "%s%s %s", ko_prefix,
2153 full_info ? addr->address : address,
2154 address_test_mode ? "is undeliverable" : "failed to verify");
2155 if (!expn && admin_user)
2157 if (addr->basic_errno > 0)
2158 respond_printf(f, ": %s", strerror(addr->basic_errno));
2160 respond_printf(f, ": %s", addr->message);
2163 /* Show parents iff doing full info */
2165 if (full_info) while (p)
2167 respond_printf(f, "%s\n <-- %s", cr, p->address);
2170 respond_printf(f, "%s\n", cr);
2172 cancel_cutthrough_connection("routing hard fail");
2176 yield = copy_error(vaddr, addr, FAIL);
2184 else if (rc == DEFER)
2189 address_item *p = addr->parent;
2190 respond_printf(f, "%s%s cannot be resolved at this time", ko_prefix,
2191 full_info? addr->address : address);
2192 if (!expn && admin_user)
2194 if (addr->basic_errno > 0)
2195 respond_printf(f, ": %s", strerror(addr->basic_errno));
2197 respond_printf(f, ": %s", addr->message);
2198 else if (addr->basic_errno <= 0)
2199 respond_printf(f, ": unknown error");
2202 /* Show parents iff doing full info */
2204 if (full_info) while (p)
2206 respond_printf(f, "%s\n <-- %s", cr, p->address);
2209 respond_printf(f, "%s\n", cr);
2211 cancel_cutthrough_connection("routing soft fail");
2215 yield = copy_error(vaddr, addr, DEFER);
2218 if (yield == OK) yield = DEFER;
2221 /* If we are handling EXPN, we do not want to continue to route beyond
2222 the top level (whose address is in "address"). */
2226 uschar *ok_prefix = US"250-";
2229 if (!addr_local && !addr_remote)
2230 respond_printf(f, "250 mail to <%s> is discarded\r\n", address);
2232 respond_printf(f, "250 <%s>\r\n", address);
2236 address_item *addr2 = addr_new;
2237 addr_new = addr2->next;
2238 if (!addr_new) ok_prefix = US"250 ";
2239 respond_printf(f, "%s<%s>\r\n", ok_prefix, addr2->address);
2245 /* Successful routing other than EXPN. */
2249 /* Handle successful routing when short info wanted. Otherwise continue for
2250 other (generated) addresses. Short info is the operational case. Full info
2251 can be requested only when debug_selector != 0 and a file is supplied.
2253 There is a conflict between the use of aliasing as an alternate email
2254 address, and as a sort of mailing list. If an alias turns the incoming
2255 address into just one address (e.g. J.Caesar->jc44) you may well want to
2256 carry on verifying the generated address to ensure it is valid when
2257 checking incoming mail. If aliasing generates multiple addresses, you
2258 probably don't want to do this. Exim therefore treats the generation of
2259 just a single new address as a special case, and continues on to verify the
2260 generated address. */
2262 if ( !full_info /* Stop if short info wanted AND */
2263 && ( ( !addr_new /* No new address OR */
2264 || addr_new->next /* More than one new address OR */
2265 || testflag(addr_new, af_pfr) /* New address is pfr */
2268 ( addr_new /* At least one new address AND */
2269 && success_on_redirect /* success_on_redirect is set */
2273 if (f) fprintf(f, "%s %s\n",
2274 address, address_test_mode ? "is deliverable" : "verified");
2276 /* If we have carried on to verify a child address, we want the value
2277 of $address_data to be that of the child */
2279 vaddr->prop.address_data = addr->prop.address_data;
2281 /* If stopped because more than one new address, cannot cutthrough */
2283 if (addr_new && addr_new->next)
2284 cancel_cutthrough_connection("multiple addresses from routing");
2290 } /* Loop for generated addresses */
2292 /* Display the full results of the successful routing, including any generated
2293 addresses. Control gets here only when full_info is set, which requires f not
2294 to be NULL, and this occurs only when a top-level verify is called with the
2295 debugging switch on.
2297 If there are no local and no remote addresses, and there were no pipes, files,
2298 or autoreplies, and there were no errors or deferments, the message is to be
2299 discarded, usually because of the use of :blackhole: in an alias file. */
2301 if (allok && !addr_local && !addr_remote)
2303 fprintf(f, "mail to %s is discarded\n", address);
2307 for (addr_list = addr_local, i = 0; i < 2; addr_list = addr_remote, i++)
2310 address_item *addr = addr_list;
2311 address_item *p = addr->parent;
2312 transport_instance * tp = addr->transport;
2314 addr_list = addr->next;
2316 fprintf(f, "%s", CS addr->address);
2317 #ifdef EXPERIMENTAL_SRS
2318 if(addr->prop.srs_sender)
2319 fprintf(f, " [srs = %s]", addr->prop.srs_sender);
2322 /* If the address is a duplicate, show something about it. */
2324 if (!testflag(addr, af_pfr))
2327 if ((tnode = tree_search(tree_duplicates, addr->unique)))
2328 fprintf(f, " [duplicate, would not be delivered]");
2329 else tree_add_duplicate(addr->unique, addr);
2332 /* Now show its parents */
2334 for (p = addr->parent; p; p = p->parent)
2335 fprintf(f, "\n <-- %s", p->address);
2338 /* Show router, and transport */
2340 fprintf(f, "router = %s, transport = %s\n",
2341 addr->router->name, tp ? tp->name : US"unset");
2343 /* Show any hosts that are set up by a router unless the transport
2344 is going to override them; fiddle a bit to get a nice format. */
2346 if (addr->host_list && tp && !tp->overrides_hosts)
2351 for (h = addr->host_list; h; h = h->next)
2352 { /* get max lengths of host names, addrs */
2353 int len = Ustrlen(h->name);
2354 if (len > maxlen) maxlen = len;
2355 len = h->address ? Ustrlen(h->address) : 7;
2356 if (len > maxaddlen) maxaddlen = len;
2358 for (h = addr->host_list; h; h = h->next)
2360 fprintf(f, " host %-*s ", maxlen, h->name);
2363 fprintf(f, "[%s%-*c", h->address, maxaddlen+1 - Ustrlen(h->address), ']');
2364 else if (tp->info->local)
2365 fprintf(f, " %-*s ", maxaddlen, ""); /* Omit [unknown] for local */
2367 fprintf(f, "[%s%-*c", "unknown", maxaddlen+1 - 7, ']');
2369 if (h->mx >= 0) fprintf(f, " MX=%d", h->mx);
2370 if (h->port != PORT_NONE) fprintf(f, " port=%d", h->port);
2371 if (running_in_test_harness && h->dnssec == DS_YES) fputs(" AD", f);
2372 if (h->status == hstatus_unusable) fputs(" ** unusable **", f);
2378 /* Yield will be DEFER or FAIL if any one address has, only for full_info (which is
2379 the -bv or -bt case). */
2383 tls_modify_variables(&tls_in);
2391 /*************************************************
2392 * Check headers for syntax errors *
2393 *************************************************/
2395 /* This function checks those header lines that contain addresses, and verifies
2396 that all the addresses therein are syntactially correct.
2399 msgptr where to put an error message
2406 verify_check_headers(uschar **msgptr)
2412 for (h = header_list; h != NULL && yield == OK; h = h->next)
2414 if (h->type != htype_from &&
2415 h->type != htype_reply_to &&
2416 h->type != htype_sender &&
2417 h->type != htype_to &&
2418 h->type != htype_cc &&
2419 h->type != htype_bcc)
2422 colon = Ustrchr(h->text, ':');
2424 while (isspace(*s)) s++;
2426 /* Loop for multiple addresses in the header, enabling group syntax. Note
2427 that we have to reset this after the header has been scanned. */
2429 parse_allow_group = TRUE;
2433 uschar *ss = parse_find_address_end(s, FALSE);
2434 uschar *recipient, *errmess;
2435 int terminator = *ss;
2436 int start, end, domain;
2438 /* Temporarily terminate the string at this point, and extract the
2439 operative address within, allowing group syntax. */
2442 recipient = parse_extract_address(s,&errmess,&start,&end,&domain,FALSE);
2445 /* Permit an unqualified address only if the message is local, or if the
2446 sending host is configured to be permitted to send them. */
2448 if (recipient != NULL && domain == 0)
2450 if (h->type == htype_from || h->type == htype_sender)
2452 if (!allow_unqualified_sender) recipient = NULL;
2456 if (!allow_unqualified_recipient) recipient = NULL;
2458 if (recipient == NULL) errmess = US"unqualified address not permitted";
2461 /* It's an error if no address could be extracted, except for the special
2462 case of an empty address. */
2464 if (recipient == NULL && Ustrcmp(errmess, "empty address") != 0)
2466 uschar *verb = US"is";
2471 /* Arrange not to include any white space at the end in the
2472 error message or the header name. */
2474 while (t > s && isspace(t[-1])) t--;
2475 while (tt > h->text && isspace(tt[-1])) tt--;
2477 /* Add the address that failed to the error message, since in a
2478 header with very many addresses it is sometimes hard to spot
2479 which one is at fault. However, limit the amount of address to
2480 quote - cases have been seen where, for example, a missing double
2481 quote in a humungous To: header creates an "address" that is longer
2482 than string_sprintf can handle. */
2491 /* deconst cast ok as we're passing a non-const to string_printing() */
2492 *msgptr = US string_printing(
2493 string_sprintf("%s: failing address in \"%.*s:\" header %s: %.*s",
2494 errmess, tt - h->text, h->text, verb, len, s));
2497 break; /* Out of address loop */
2500 /* Advance to the next address */
2502 s = ss + (terminator? 1:0);
2503 while (isspace(*s)) s++;
2504 } /* Next address */
2506 parse_allow_group = FALSE;
2507 parse_found_group = FALSE;
2508 } /* Next header unless yield has been set FALSE */
2514 /*************************************************
2515 * Check header names for 8-bit characters *
2516 *************************************************/
2518 /* This function checks for invalid charcters in header names. See
2519 RFC 5322, 2.2. and RFC 6532, 3.
2522 msgptr where to put an error message
2529 verify_check_header_names_ascii(uschar **msgptr)
2534 for (h = header_list; h != NULL; h = h->next)
2536 colon = Ustrchr(h->text, ':');
2537 for(s = h->text; s < colon; s++)
2539 if ((*s < 33) || (*s > 126))
2541 *msgptr = string_sprintf("Invalid character in header \"%.*s\" found",
2542 colon - h->text, h->text);
2550 /*************************************************
2551 * Check for blind recipients *
2552 *************************************************/
2554 /* This function checks that every (envelope) recipient is mentioned in either
2555 the To: or Cc: header lines, thus detecting blind carbon copies.
2557 There are two ways of scanning that could be used: either scan the header lines
2558 and tick off the recipients, or scan the recipients and check the header lines.
2559 The original proposed patch did the former, but I have chosen to do the latter,
2560 because (a) it requires no memory and (b) will use fewer resources when there
2561 are many addresses in To: and/or Cc: and only one or two envelope recipients.
2564 Returns: OK if there are no blind recipients
2565 FAIL if there is at least one blind recipient
2569 verify_check_notblind(void)
2572 for (i = 0; i < recipients_count; i++)
2576 uschar *address = recipients_list[i].address;
2578 for (h = header_list; !found && h != NULL; h = h->next)
2582 if (h->type != htype_to && h->type != htype_cc) continue;
2584 colon = Ustrchr(h->text, ':');
2586 while (isspace(*s)) s++;
2588 /* Loop for multiple addresses in the header, enabling group syntax. Note
2589 that we have to reset this after the header has been scanned. */
2591 parse_allow_group = TRUE;
2595 uschar *ss = parse_find_address_end(s, FALSE);
2596 uschar *recipient,*errmess;
2597 int terminator = *ss;
2598 int start, end, domain;
2600 /* Temporarily terminate the string at this point, and extract the
2601 operative address within, allowing group syntax. */
2604 recipient = parse_extract_address(s,&errmess,&start,&end,&domain,FALSE);
2607 /* If we found a valid recipient that has a domain, compare it with the
2608 envelope recipient. Local parts are compared case-sensitively, domains
2609 case-insensitively. By comparing from the start with length "domain", we
2610 include the "@" at the end, which ensures that we are comparing the whole
2611 local part of each address. */
2613 if (recipient != NULL && domain != 0)
2615 found = Ustrncmp(recipient, address, domain) == 0 &&
2616 strcmpic(recipient + domain, address + domain) == 0;
2620 /* Advance to the next address */
2622 s = ss + (terminator? 1:0);
2623 while (isspace(*s)) s++;
2624 } /* Next address */
2626 parse_allow_group = FALSE;
2627 parse_found_group = FALSE;
2628 } /* Next header (if found is false) */
2630 if (!found) return FAIL;
2631 } /* Next recipient */
2638 /*************************************************
2639 * Find if verified sender *
2640 *************************************************/
2642 /* Usually, just a single address is verified as the sender of the message.
2643 However, Exim can be made to verify other addresses as well (often related in
2644 some way), and this is useful in some environments. There may therefore be a
2645 chain of such addresses that have previously been tested. This function finds
2646 whether a given address is on the chain.
2648 Arguments: the address to be verified
2649 Returns: pointer to an address item, or NULL
2653 verify_checked_sender(uschar *sender)
2656 for (addr = sender_verified_list; addr != NULL; addr = addr->next)
2657 if (Ustrcmp(sender, addr->address) == 0) break;
2665 /*************************************************
2666 * Get valid header address *
2667 *************************************************/
2669 /* Scan the originator headers of the message, looking for an address that
2670 verifies successfully. RFC 822 says:
2672 o The "Sender" field mailbox should be sent notices of
2673 any problems in transport or delivery of the original
2674 messages. If there is no "Sender" field, then the
2675 "From" field mailbox should be used.
2677 o If the "Reply-To" field exists, then the reply should
2678 go to the addresses indicated in that field and not to
2679 the address(es) indicated in the "From" field.
2681 So we check a Sender field if there is one, else a Reply_to field, else a From
2682 field. As some strange messages may have more than one of these fields,
2683 especially if they are resent- fields, check all of them if there is more than
2687 user_msgptr points to where to put a user error message
2688 log_msgptr points to where to put a log error message
2689 callout timeout for callout check (passed to verify_address())
2690 callout_overall overall callout timeout (ditto)
2691 callout_connect connect callout timeout (ditto)
2692 se_mailfrom mailfrom for verify; NULL => ""
2693 pm_mailfrom sender for pm callout check (passed to verify_address())
2694 options callout options (passed to verify_address())
2695 verrno where to put the address basic_errno
2697 If log_msgptr is set to something without setting user_msgptr, the caller
2698 normally uses log_msgptr for both things.
2700 Returns: result of the verification attempt: OK, FAIL, or DEFER;
2701 FAIL is given if no appropriate headers are found
2705 verify_check_header_address(uschar **user_msgptr, uschar **log_msgptr,
2706 int callout, int callout_overall, int callout_connect, uschar *se_mailfrom,
2707 uschar *pm_mailfrom, int options, int *verrno)
2709 static int header_types[] = { htype_sender, htype_reply_to, htype_from };
2714 for (i = 0; i < 3 && !done; i++)
2717 for (h = header_list; h != NULL && !done; h = h->next)
2719 int terminator, new_ok;
2720 uschar *s, *ss, *endname;
2722 if (h->type != header_types[i]) continue;
2723 s = endname = Ustrchr(h->text, ':') + 1;
2725 /* Scan the addresses in the header, enabling group syntax. Note that we
2726 have to reset this after the header has been scanned. */
2728 parse_allow_group = TRUE;
2732 address_item *vaddr;
2734 while (isspace(*s) || *s == ',') s++;
2735 if (*s == 0) break; /* End of header */
2737 ss = parse_find_address_end(s, FALSE);
2739 /* The terminator is a comma or end of header, but there may be white
2740 space preceding it (including newline for the last address). Move back
2741 past any white space so we can check against any cached envelope sender
2742 address verifications. */
2744 while (isspace(ss[-1])) ss--;
2748 HDEBUG(D_verify) debug_printf("verifying %.*s header address %s\n",
2749 (int)(endname - h->text), h->text, s);
2751 /* See if we have already verified this address as an envelope sender,
2752 and if so, use the previous answer. */
2754 vaddr = verify_checked_sender(s);
2756 if (vaddr != NULL && /* Previously checked */
2757 (callout <= 0 || /* No callout needed; OR */
2758 vaddr->special_action > 256)) /* Callout was done */
2760 new_ok = vaddr->special_action & 255;
2761 HDEBUG(D_verify) debug_printf("previously checked as envelope sender\n");
2762 *ss = terminator; /* Restore shortened string */
2765 /* Otherwise we run the verification now. We must restore the shortened
2766 string before running the verification, so the headers are correct, in
2767 case there is any rewriting. */
2771 int start, end, domain;
2772 uschar *address = parse_extract_address(s, log_msgptr, &start, &end,
2777 /* If we found an empty address, just carry on with the next one, but
2778 kill the message. */
2780 if (address == NULL && Ustrcmp(*log_msgptr, "empty address") == 0)
2787 /* If verification failed because of a syntax error, fail this
2788 function, and ensure that the failing address gets added to the error
2791 if (address == NULL)
2794 while (ss > s && isspace(ss[-1])) ss--;
2795 *log_msgptr = string_sprintf("syntax error in '%.*s' header when "
2796 "scanning for sender: %s in \"%.*s\"",
2797 endname - h->text, h->text, *log_msgptr, ss - s, s);
2803 /* Else go ahead with the sender verification. But it isn't *the*
2804 sender of the message, so set vopt_fake_sender to stop sender_address
2805 being replaced after rewriting or qualification. */
2809 vaddr = deliver_make_addr(address, FALSE);
2810 new_ok = verify_address(vaddr, NULL, options | vopt_fake_sender,
2811 callout, callout_overall, callout_connect, se_mailfrom,
2816 /* We now have the result, either newly found, or cached. If we are
2817 giving out error details, set a specific user error. This means that the
2818 last of these will be returned to the user if all three fail. We do not
2819 set a log message - the generic one below will be used. */
2823 *verrno = vaddr->basic_errno;
2824 if (smtp_return_error_details)
2826 *user_msgptr = string_sprintf("Rejected after DATA: "
2827 "could not verify \"%.*s\" header address\n%s: %s",
2828 endname - h->text, h->text, vaddr->address, vaddr->message);
2832 /* Success or defer */
2841 if (new_ok == DEFER) yield = DEFER;
2843 /* Move on to any more addresses in the header */
2846 } /* Next address */
2848 parse_allow_group = FALSE;
2849 parse_found_group = FALSE;
2850 } /* Next header, unless done */
2851 } /* Next header type unless done */
2853 if (yield == FAIL && *log_msgptr == NULL)
2854 *log_msgptr = US"there is no valid sender in any header line";
2856 if (yield == DEFER && *log_msgptr == NULL)
2857 *log_msgptr = US"all attempts to verify a sender in a header line deferred";
2865 /*************************************************
2866 * Get RFC 1413 identification *
2867 *************************************************/
2869 /* Attempt to get an id from the sending machine via the RFC 1413 protocol. If
2870 the timeout is set to zero, then the query is not done. There may also be lists
2871 of hosts and nets which are exempt. To guard against malefactors sending
2872 non-printing characters which could, for example, disrupt a message's headers,
2873 make sure the string consists of printing characters only.
2876 port the port to connect to; usually this is IDENT_PORT (113), but when
2877 running in the test harness with -bh a different value is used.
2881 Side effect: any received ident value is put in sender_ident (NULL otherwise)
2885 verify_get_ident(int port)
2887 int sock, host_af, qlen;
2888 int received_sender_port, received_interface_port, n;
2890 uschar buffer[2048];
2892 /* Default is no ident. Check whether we want to do an ident check for this
2895 sender_ident = NULL;
2896 if (rfc1413_query_timeout <= 0 || verify_check_host(&rfc1413_hosts) != OK)
2899 DEBUG(D_ident) debug_printf("doing ident callback\n");
2901 /* Set up a connection to the ident port of the remote host. Bind the local end
2902 to the incoming interface address. If the sender host address is an IPv6
2903 address, the incoming interface address will also be IPv6. */
2905 host_af = (Ustrchr(sender_host_address, ':') == NULL)? AF_INET : AF_INET6;
2906 sock = ip_socket(SOCK_STREAM, host_af);
2907 if (sock < 0) return;
2909 if (ip_bind(sock, host_af, interface_address, 0) < 0)
2911 DEBUG(D_ident) debug_printf("bind socket for ident failed: %s\n",
2916 if (ip_connect(sock, host_af, sender_host_address, port, rfc1413_query_timeout)
2919 if (errno == ETIMEDOUT && LOGGING(ident_timeout))
2921 log_write(0, LOG_MAIN, "ident connection to %s timed out",
2922 sender_host_address);
2926 DEBUG(D_ident) debug_printf("ident connection to %s failed: %s\n",
2927 sender_host_address, strerror(errno));
2932 /* Construct and send the query. */
2934 sprintf(CS buffer, "%d , %d\r\n", sender_host_port, interface_port);
2935 qlen = Ustrlen(buffer);
2936 if (send(sock, buffer, qlen, 0) < 0)
2938 DEBUG(D_ident) debug_printf("ident send failed: %s\n", strerror(errno));
2942 /* Read a response line. We put it into the rest of the buffer, using several
2943 recv() calls if necessary. */
2951 int size = sizeof(buffer) - (p - buffer);
2953 if (size <= 0) goto END_OFF; /* Buffer filled without seeing \n. */
2954 count = ip_recv(sock, p, size, rfc1413_query_timeout);
2955 if (count <= 0) goto END_OFF; /* Read error or EOF */
2957 /* Scan what we just read, to see if we have reached the terminating \r\n. Be
2958 generous, and accept a plain \n terminator as well. The only illegal
2961 for (pp = p; pp < p + count; pp++)
2963 if (*pp == 0) goto END_OFF; /* Zero octet not allowed */
2966 if (pp[-1] == '\r') pp--;
2968 goto GOT_DATA; /* Break out of both loops */
2972 /* Reached the end of the data without finding \n. Let the loop continue to
2973 read some more, if there is room. */
2980 /* We have received a line of data. Check it carefully. It must start with the
2981 same two port numbers that we sent, followed by data as defined by the RFC. For
2984 12345 , 25 : USERID : UNIX :root
2986 However, the amount of white space may be different to what we sent. In the
2987 "osname" field there may be several sub-fields, comma separated. The data we
2988 actually want to save follows the third colon. Some systems put leading spaces
2989 in it - we discard those. */
2991 if (sscanf(CS buffer + qlen, "%d , %d%n", &received_sender_port,
2992 &received_interface_port, &n) != 2 ||
2993 received_sender_port != sender_host_port ||
2994 received_interface_port != interface_port)
2997 p = buffer + qlen + n;
2998 while(isspace(*p)) p++;
2999 if (*p++ != ':') goto END_OFF;
3000 while(isspace(*p)) p++;
3001 if (Ustrncmp(p, "USERID", 6) != 0) goto END_OFF;
3003 while(isspace(*p)) p++;
3004 if (*p++ != ':') goto END_OFF;
3005 while (*p != 0 && *p != ':') p++;
3006 if (*p++ == 0) goto END_OFF;
3007 while(isspace(*p)) p++;
3008 if (*p == 0) goto END_OFF;
3010 /* The rest of the line is the data we want. We turn it into printing
3011 characters when we save it, so that it cannot mess up the format of any logging
3012 or Received: lines into which it gets inserted. We keep a maximum of 127
3013 characters. The deconst cast is ok as we fed a nonconst to string_printing() */
3015 sender_ident = US string_printing(string_copyn(p, 127));
3016 DEBUG(D_ident) debug_printf("sender_ident = %s\n", sender_ident);
3026 /*************************************************
3027 * Match host to a single host-list item *
3028 *************************************************/
3030 /* This function compares a host (name or address) against a single item
3031 from a host list. The host name gets looked up if it is needed and is not
3032 already known. The function is called from verify_check_this_host() via
3033 match_check_list(), which is why most of its arguments are in a single block.
3036 arg the argument block (see below)
3037 ss the host-list item
3038 valueptr where to pass back looked up data, or NULL
3039 error for error message when returning ERROR
3042 host_name (a) the host name, or
3043 (b) NULL, implying use sender_host_name and
3044 sender_host_aliases, looking them up if required, or
3045 (c) the empty string, meaning that only IP address matches
3047 host_address the host address
3048 host_ipv4 the IPv4 address taken from an IPv6 one
3052 DEFER lookup deferred
3053 ERROR (a) failed to find the host name or IP address, or
3054 (b) unknown lookup type specified, or
3055 (c) host name encountered when only IP addresses are
3060 check_host(void *arg, const uschar *ss, const uschar **valueptr, uschar **error)
3062 check_host_block *cb = (check_host_block *)arg;
3065 BOOL iplookup = FALSE;
3066 BOOL isquery = FALSE;
3067 BOOL isiponly = cb->host_name != NULL && cb->host_name[0] == 0;
3072 /* Optimize for the special case when the pattern is "*". */
3074 if (*ss == '*' && ss[1] == 0) return OK;
3076 /* If the pattern is empty, it matches only in the case when there is no host -
3077 this can occur in ACL checking for SMTP input using the -bs option. In this
3078 situation, the host address is the empty string. */
3080 if (cb->host_address[0] == 0) return (*ss == 0)? OK : FAIL;
3081 if (*ss == 0) return FAIL;
3083 /* If the pattern is precisely "@" then match against the primary host name,
3084 provided that host name matching is permitted; if it's "@[]" match against the
3085 local host's IP addresses. */
3091 if (isiponly) return ERROR;
3092 ss = primary_hostname;
3094 else if (Ustrcmp(ss, "@[]") == 0)
3096 ip_address_item *ip;
3097 for (ip = host_find_interfaces(); ip != NULL; ip = ip->next)
3098 if (Ustrcmp(ip->address, cb->host_address) == 0) return OK;
3103 /* If the pattern is an IP address, optionally followed by a bitmask count, do
3104 a (possibly masked) comparision with the current IP address. */
3106 if (string_is_ip_address(ss, &maskoffset) != 0)
3107 return (host_is_in_net(cb->host_address, ss, maskoffset)? OK : FAIL);
3109 /* The pattern is not an IP address. A common error that people make is to omit
3110 one component of an IPv4 address, either by accident, or believing that, for
3111 example, 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,
3112 which it isn't. (Those applications that do accept 1.2.3 as an IP address
3113 interpret it as 1.2.0.3 because the final component becomes 16-bit - this is an
3114 ancient specification.) To aid in debugging these cases, we give a specific
3115 error if the pattern contains only digits and dots or contains a slash preceded
3116 only by digits and dots (a slash at the start indicates a file name and of
3117 course slashes may be present in lookups, but not preceded only by digits and
3120 for (t = ss; isdigit(*t) || *t == '.'; t++);
3121 if (*t == 0 || (*t == '/' && t != ss))
3123 *error = US"malformed IPv4 address or address mask";
3127 /* See if there is a semicolon in the pattern */
3129 semicolon = Ustrchr(ss, ';');
3131 /* If we are doing an IP address only match, then all lookups must be IP
3132 address lookups, even if there is no "net-". */
3136 iplookup = semicolon != NULL;
3139 /* Otherwise, if the item is of the form net[n]-lookup;<file|query> then it is
3140 a lookup on a masked IP network, in textual form. We obey this code even if we
3141 have already set iplookup, so as to skip over the "net-" prefix and to set the
3142 mask length. The net- stuff really only applies to single-key lookups where the
3143 key is implicit. For query-style lookups the key is specified in the query.
3144 From release 4.30, the use of net- for query style is no longer needed, but we
3145 retain it for backward compatibility. */
3147 if (Ustrncmp(ss, "net", 3) == 0 && semicolon != NULL)
3150 for (t = ss + 3; isdigit(*t); t++) mlen = mlen * 10 + *t - '0';
3151 if (mlen == 0 && t == ss+3) mlen = -1; /* No mask supplied */
3152 iplookup = (*t++ == '-');
3156 /* Do the IP address lookup if that is indeed what we have */
3164 uschar *filename, *key, *result;
3167 /* Find the search type */
3169 search_type = search_findtype(t, semicolon - t);
3171 if (search_type < 0) log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s",
3172 search_error_message);
3174 /* Adjust parameters for the type of lookup. For a query-style lookup, there
3175 is no file name, and the "key" is just the query. For query-style with a file
3176 name, we have to fish the file off the start of the query. For a single-key
3177 lookup, the key is the current IP address, masked appropriately, and
3178 reconverted to text form, with the mask appended. For IPv6 addresses, specify
3179 dot separators instead of colons, except when the lookup type is "iplsearch".
3182 if (mac_islookup(search_type, lookup_absfilequery))
3184 filename = semicolon + 1;
3186 while (*key != 0 && !isspace(*key)) key++;
3187 filename = string_copyn(filename, key - filename);
3188 while (isspace(*key)) key++;
3190 else if (mac_islookup(search_type, lookup_querystyle))
3193 key = semicolon + 1;
3195 else /* Single-key style */
3197 int sep = (Ustrcmp(lookup_list[search_type]->name, "iplsearch") == 0)?
3199 insize = host_aton(cb->host_address, incoming);
3200 host_mask(insize, incoming, mlen);
3201 (void)host_nmtoa(insize, incoming, mlen, buffer, sep);
3203 filename = semicolon + 1;
3206 /* Now do the actual lookup; note that there is no search_close() because
3207 of the caching arrangements. */
3209 if (!(handle = search_open(filename, search_type, 0, NULL, NULL)))
3210 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", search_error_message);
3212 result = search_find(handle, filename, key, -1, NULL, 0, 0, NULL);
3213 if (valueptr != NULL) *valueptr = result;
3214 return (result != NULL)? OK : search_find_defer? DEFER: FAIL;
3217 /* The pattern is not an IP address or network reference of any kind. That is,
3218 it is a host name pattern. If this is an IP only match, there's an error in the
3223 *error = US"cannot match host name in match_ip list";
3227 /* Check the characters of the pattern to see if they comprise only letters,
3228 digits, full stops, and hyphens (the constituents of domain names). Allow
3229 underscores, as they are all too commonly found. Sigh. Also, if
3230 allow_utf8_domains is set, allow top-bit characters. */
3232 for (t = ss; *t != 0; t++)
3233 if (!isalnum(*t) && *t != '.' && *t != '-' && *t != '_' &&
3234 (!allow_utf8_domains || *t < 128)) break;
3236 /* If the pattern is a complete domain name, with no fancy characters, look up
3237 its IP address and match against that. Note that a multi-homed host will add
3238 items to the chain. */
3249 /* Using byname rather than bydns here means we cannot determine dnssec
3250 status. On the other hand it is unclear how that could be either
3251 propagated up or enforced. */
3253 rc = host_find_byname(&h, NULL, HOST_FIND_QUALIFY_SINGLE, NULL, FALSE);
3254 if (rc == HOST_FOUND || rc == HOST_FOUND_LOCAL)
3257 for (hh = &h; hh != NULL; hh = hh->next)
3259 if (host_is_in_net(hh->address, cb->host_address, 0)) return OK;
3263 if (rc == HOST_FIND_AGAIN) return DEFER;
3264 *error = string_sprintf("failed to find IP address for %s", ss);
3268 /* Almost all subsequent comparisons require the host name, and can be done
3269 using the general string matching function. When this function is called for
3270 outgoing hosts, the name is always given explicitly. If it is NULL, it means we
3271 must use sender_host_name and its aliases, looking them up if necessary. */
3273 if (cb->host_name != NULL) /* Explicit host name given */
3274 return match_check_string(cb->host_name, ss, -1, TRUE, TRUE, TRUE,
3277 /* Host name not given; in principle we need the sender host name and its
3278 aliases. However, for query-style lookups, we do not need the name if the
3279 query does not contain $sender_host_name. From release 4.23, a reference to
3280 $sender_host_name causes it to be looked up, so we don't need to do the lookup
3283 if ((semicolon = Ustrchr(ss, ';')) != NULL)
3285 const uschar *affix;
3286 int partial, affixlen, starflags, id;
3289 id = search_findtype_partial(ss, &partial, &affix, &affixlen, &starflags);
3292 if (id < 0) /* Unknown lookup type */
3294 log_write(0, LOG_MAIN|LOG_PANIC, "%s in host list item \"%s\"",
3295 search_error_message, ss);
3298 isquery = mac_islookup(id, lookup_querystyle|lookup_absfilequery);
3303 switch(match_check_string(US"", ss, -1, TRUE, TRUE, TRUE, valueptr))
3306 case DEFER: return DEFER;
3307 default: return FAIL;
3311 /* Not a query-style lookup; must ensure the host name is present, and then we
3312 do a check on the name and all its aliases. */
3314 if (sender_host_name == NULL)
3316 HDEBUG(D_host_lookup)
3317 debug_printf("sender host name required, to match against %s\n", ss);
3318 if (host_lookup_failed || host_name_lookup() != OK)
3320 *error = string_sprintf("failed to find host name for %s",
3321 sender_host_address);;
3324 host_build_sender_fullhost();
3327 /* Match on the sender host name, using the general matching function */
3329 switch(match_check_string(sender_host_name, ss, -1, TRUE, TRUE, TRUE,
3333 case DEFER: return DEFER;
3336 /* If there are aliases, try matching on them. */
3338 aliases = sender_host_aliases;
3339 while (*aliases != NULL)
3341 switch(match_check_string(*aliases++, ss, -1, TRUE, TRUE, TRUE, valueptr))
3344 case DEFER: return DEFER;
3353 /*************************************************
3354 * Check a specific host matches a host list *
3355 *************************************************/
3357 /* This function is passed a host list containing items in a number of
3358 different formats and the identity of a host. Its job is to determine whether
3359 the given host is in the set of hosts defined by the list. The host name is
3360 passed as a pointer so that it can be looked up if needed and not already
3361 known. This is commonly the case when called from verify_check_host() to check
3362 an incoming connection. When called from elsewhere the host name should usually
3365 This function is now just a front end to match_check_list(), which runs common
3366 code for scanning a list. We pass it the check_host() function to perform a
3370 listptr pointer to the host list
3371 cache_bits pointer to cache for named lists, or NULL
3372 host_name the host name or NULL, implying use sender_host_name and
3373 sender_host_aliases, looking them up if required
3374 host_address the IP address
3375 valueptr if not NULL, data from a lookup is passed back here
3377 Returns: OK if the host is in the defined set
3378 FAIL if the host is not in the defined set,
3379 DEFER if a data lookup deferred (not a host lookup)
3381 If the host name was needed in order to make a comparison, and could not be
3382 determined from the IP address, the result is FAIL unless the item
3383 "+allow_unknown" was met earlier in the list, in which case OK is returned. */
3386 verify_check_this_host(const uschar **listptr, unsigned int *cache_bits,
3387 const uschar *host_name, const uschar *host_address, const uschar **valueptr)
3390 unsigned int *local_cache_bits = cache_bits;
3391 const uschar *save_host_address = deliver_host_address;
3392 check_host_block cb;
3393 cb.host_name = host_name;
3394 cb.host_address = host_address;
3396 if (valueptr != NULL) *valueptr = NULL;
3398 /* If the host address starts off ::ffff: it is an IPv6 address in
3399 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3402 cb.host_ipv4 = (Ustrncmp(host_address, "::ffff:", 7) == 0)?
3403 host_address + 7 : host_address;
3405 /* During the running of the check, put the IP address into $host_address. In
3406 the case of calls from the smtp transport, it will already be there. However,
3407 in other calls (e.g. when testing ignore_target_hosts), it won't. Just to be on
3408 the safe side, any existing setting is preserved, though as I write this
3409 (November 2004) I can't see any cases where it is actually needed. */
3411 deliver_host_address = host_address;
3412 rc = match_check_list(
3413 listptr, /* the list */
3414 0, /* separator character */
3415 &hostlist_anchor, /* anchor pointer */
3416 &local_cache_bits, /* cache pointer */
3417 check_host, /* function for testing */
3418 &cb, /* argument for function */
3419 MCL_HOST, /* type of check */
3420 (host_address == sender_host_address)?
3421 US"host" : host_address, /* text for debugging */
3422 valueptr); /* where to pass back data */
3423 deliver_host_address = save_host_address;
3430 /*************************************************
3431 * Check the given host item matches a list *
3432 *************************************************/
3434 verify_check_given_host(uschar **listptr, host_item *host)
3436 return verify_check_this_host(CUSS listptr, NULL, host->name, host->address, NULL);
3439 /*************************************************
3440 * Check the remote host matches a list *
3441 *************************************************/
3443 /* This is a front end to verify_check_this_host(), created because checking
3444 the remote host is a common occurrence. With luck, a good compiler will spot
3445 the tail recursion and optimize it. If there's no host address, this is
3446 command-line SMTP input - check against an empty string for the address.
3449 listptr pointer to the host list
3451 Returns: the yield of verify_check_this_host(),
3452 i.e. OK, FAIL, or DEFER
3456 verify_check_host(uschar **listptr)
3458 return verify_check_this_host(CUSS listptr, sender_host_cache, NULL,
3459 (sender_host_address == NULL)? US"" : sender_host_address, NULL);
3466 /*************************************************
3467 * Invert an IP address *
3468 *************************************************/
3470 /* Originally just used for DNS xBL lists, now also used for the
3471 reverse_ip expansion operator.
3474 buffer where to put the answer
3475 address the address to invert
3479 invert_address(uschar *buffer, uschar *address)
3482 uschar *bptr = buffer;
3484 /* If this is an IPv4 address mapped into IPv6 format, adjust the pointer
3485 to the IPv4 part only. */
3487 if (Ustrncmp(address, "::ffff:", 7) == 0) address += 7;
3489 /* Handle IPv4 address: when HAVE_IPV6 is false, the result of host_aton() is
3492 if (host_aton(address, bin) == 1)
3496 for (i = 0; i < 4; i++)
3498 sprintf(CS bptr, "%d.", x & 255);
3499 while (*bptr) bptr++;
3504 /* Handle IPv6 address. Actually, as far as I know, there are no IPv6 addresses
3505 in any DNS black lists, and the format in which they will be looked up is
3506 unknown. This is just a guess. */
3512 for (j = 3; j >= 0; j--)
3515 for (i = 0; i < 8; i++)
3517 sprintf(CS bptr, "%x.", x & 15);
3518 while (*bptr) bptr++;
3525 /* Remove trailing period -- this is needed so that both arbitrary
3526 dnsbl keydomains and inverted addresses may be combined with the
3527 same format string, "%s.%s" */
3534 /*************************************************
3535 * Perform a single dnsbl lookup *
3536 *************************************************/
3538 /* This function is called from verify_check_dnsbl() below. It is also called
3539 recursively from within itself when domain and domain_txt are different
3540 pointers, in order to get the TXT record from the alternate domain.
3543 domain the outer dnsbl domain
3544 domain_txt alternate domain to lookup TXT record on success; when the
3545 same domain is to be used, domain_txt == domain (that is,
3546 the pointers must be identical, not just the text)
3547 keydomain the current keydomain (for debug message)
3548 prepend subdomain to lookup (like keydomain, but
3549 reversed if IP address)
3550 iplist the list of matching IP addresses, or NULL for "any"
3551 bitmask true if bitmask matching is wanted
3552 match_type condition for 'succeed' result
3553 0 => Any RR in iplist (=)
3554 1 => No RR in iplist (!=)
3555 2 => All RRs in iplist (==)
3556 3 => Some RRs not in iplist (!==)
3557 the two bits are defined as MT_NOT and MT_ALL
3558 defer_return what to return for a defer
3560 Returns: OK if lookup succeeded
3565 one_check_dnsbl(uschar *domain, uschar *domain_txt, uschar *keydomain,
3566 uschar *prepend, uschar *iplist, BOOL bitmask, int match_type,
3572 dnsbl_cache_block *cb;
3573 int old_pool = store_pool;
3574 uschar query[256]; /* DNS domain max length */
3576 /* Construct the specific query domainname */
3578 if (!string_format(query, sizeof(query), "%s.%s", prepend, domain))
3580 log_write(0, LOG_MAIN|LOG_PANIC, "dnslist query is too long "
3581 "(ignored): %s...", query);
3585 /* Look for this query in the cache. */
3587 if ( (t = tree_search(dnsbl_cache, query))
3588 && (cb = t->data.ptr)->expiry > time(NULL)
3591 /* Previous lookup was cached */
3594 HDEBUG(D_dnsbl) debug_printf("using result of previous DNS lookup\n");
3597 /* If not cached from a previous lookup, we must do a DNS lookup, and
3598 cache the result in permanent memory. */
3604 store_pool = POOL_PERM;
3608 HDEBUG(D_dnsbl) debug_printf("cached data found but past valid time; ");
3612 { /* Set up a tree entry to cache the lookup */
3613 t = store_get(sizeof(tree_node) + Ustrlen(query));
3614 Ustrcpy(t->name, query);
3615 t->data.ptr = cb = store_get(sizeof(dnsbl_cache_block));
3616 (void)tree_insertnode(&dnsbl_cache, t);
3619 /* Do the DNS loopup . */
3621 HDEBUG(D_dnsbl) debug_printf("new DNS lookup for %s\n", query);
3622 cb->rc = dns_basic_lookup(&dnsa, query, T_A);
3623 cb->text_set = FALSE;
3627 /* If the lookup succeeded, cache the RHS address. The code allows for
3628 more than one address - this was for complete generality and the possible
3629 use of A6 records. However, A6 records have been reduced to experimental
3630 status (August 2001) and may die out. So they may never get used at all,
3631 let alone in dnsbl records. However, leave the code here, just in case.
3633 Quite apart from one A6 RR generating multiple addresses, there are DNS
3634 lists that return more than one A record, so we must handle multiple
3635 addresses generated in that way as well.
3637 Mark the cache entry with the "now" plus the minimum of the address TTLs,
3638 or some suitably far-future time if none were found. */
3640 if (cb->rc == DNS_SUCCEED)
3643 dns_address **addrp = &(cb->rhs);
3644 for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
3646 rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
3648 if (rr->type == T_A)
3650 dns_address *da = dns_address_from_rr(&dnsa, rr);
3654 while (da->next != NULL) da = da->next;
3655 addrp = &(da->next);
3656 if (ttl > rr->ttl) ttl = rr->ttl;
3661 /* If we didn't find any A records, change the return code. This can
3662 happen when there is a CNAME record but there are no A records for what
3665 if (cb->rhs == NULL) cb->rc = DNS_NODATA;
3668 cb->expiry = time(NULL)+ttl;
3669 store_pool = old_pool;
3672 /* We now have the result of the DNS lookup, either newly done, or cached
3673 from a previous call. If the lookup succeeded, check against the address
3674 list if there is one. This may be a positive equality list (introduced by
3675 "="), a negative equality list (introduced by "!="), a positive bitmask
3676 list (introduced by "&"), or a negative bitmask list (introduced by "!&").*/
3678 if (cb->rc == DNS_SUCCEED)
3680 dns_address *da = NULL;
3681 uschar *addlist = cb->rhs->address;
3683 /* For A and AAAA records, there may be multiple addresses from multiple
3684 records. For A6 records (currently not expected to be used) there may be
3685 multiple addresses from a single record. */
3687 for (da = cb->rhs->next; da != NULL; da = da->next)
3688 addlist = string_sprintf("%s, %s", addlist, da->address);
3690 HDEBUG(D_dnsbl) debug_printf("DNS lookup for %s succeeded (yielding %s)\n",
3693 /* Address list check; this can be either for equality, or via a bitmask.
3694 In the latter case, all the bits must match. */
3698 for (da = cb->rhs; da != NULL; da = da->next)
3702 const uschar *ptr = iplist;
3705 /* Handle exact matching */
3709 while ((res = string_nextinlist(&ptr, &ipsep, ip, sizeof(ip))) != NULL)
3711 if (Ustrcmp(CS da->address, ip) == 0) break;
3715 /* Handle bitmask matching */
3722 /* At present, all known DNS blocking lists use A records, with
3723 IPv4 addresses on the RHS encoding the information they return. I
3724 wonder if this will linger on as the last vestige of IPv4 when IPv6
3725 is ubiquitous? Anyway, for now we use paranoia code to completely
3726 ignore IPv6 addresses. The default mask is 0, which always matches.
3727 We change this only for IPv4 addresses in the list. */
3729 if (host_aton(da->address, address) == 1) mask = address[0];
3731 /* Scan the returned addresses, skipping any that are IPv6 */
3733 while ((res = string_nextinlist(&ptr, &ipsep, ip, sizeof(ip))) != NULL)
3735 if (host_aton(ip, address) != 1) continue;
3736 if ((address[0] & mask) == address[0]) break;
3742 (a) An IP address in an any ('=') list matched, or
3743 (b) No IP address in an all ('==') list matched
3745 then we're done searching. */
3747 if (((match_type & MT_ALL) != 0) == (res == NULL)) break;
3750 /* If da == NULL, either
3752 (a) No IP address in an any ('=') list matched, or
3753 (b) An IP address in an all ('==') list didn't match
3755 so behave as if the DNSBL lookup had not succeeded, i.e. the host is not on
3758 if ((match_type == MT_NOT || match_type == MT_ALL) != (da == NULL))
3766 res = US"was no match";
3769 res = US"was an exclude match";
3772 res = US"was an IP address that did not match";
3775 res = US"were no IP addresses that did not match";
3778 debug_printf("=> but we are not accepting this block class because\n");
3779 debug_printf("=> there %s for %s%c%s\n",
3781 ((match_type & MT_ALL) == 0)? "" : "=",
3782 bitmask? '&' : '=', iplist);
3788 /* Either there was no IP list, or the record matched, implying that the
3789 domain is on the list. We now want to find a corresponding TXT record. If an
3790 alternate domain is specified for the TXT record, call this function
3791 recursively to look that up; this has the side effect of re-checking that
3792 there is indeed an A record at the alternate domain. */
3794 if (domain_txt != domain)
3795 return one_check_dnsbl(domain_txt, domain_txt, keydomain, prepend, NULL,
3796 FALSE, match_type, defer_return);
3798 /* If there is no alternate domain, look up a TXT record in the main domain
3799 if it has not previously been cached. */
3803 cb->text_set = TRUE;
3804 if (dns_basic_lookup(&dnsa, query, T_TXT) == DNS_SUCCEED)
3807 for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
3809 rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
3810 if (rr->type == T_TXT) break;
3813 int len = (rr->data)[0];
3814 if (len > 511) len = 127;
3815 store_pool = POOL_PERM;
3816 cb->text = string_sprintf("%.*s", len, (const uschar *)(rr->data+1));
3817 store_pool = old_pool;
3822 dnslist_value = addlist;
3823 dnslist_text = cb->text;
3827 /* There was a problem with the DNS lookup */
3829 if (cb->rc != DNS_NOMATCH && cb->rc != DNS_NODATA)
3831 log_write(L_dnslist_defer, LOG_MAIN,
3832 "DNS list lookup defer (probably timeout) for %s: %s", query,
3833 (defer_return == OK)? US"assumed in list" :
3834 (defer_return == FAIL)? US"assumed not in list" :
3835 US"returned DEFER");
3836 return defer_return;
3839 /* No entry was found in the DNS; continue for next domain */
3843 debug_printf("DNS lookup for %s failed\n", query);
3844 debug_printf("=> that means %s is not listed at %s\n",
3854 /*************************************************
3855 * Check host against DNS black lists *
3856 *************************************************/
3858 /* This function runs checks against a list of DNS black lists, until one
3859 matches. Each item on the list can be of the form
3861 domain=ip-address/key
3863 The domain is the right-most domain that is used for the query, for example,
3864 blackholes.mail-abuse.org. If the IP address is present, there is a match only
3865 if the DNS lookup returns a matching IP address. Several addresses may be
3866 given, comma-separated, for example: x.y.z=127.0.0.1,127.0.0.2.
3868 If no key is given, what is looked up in the domain is the inverted IP address
3869 of the current client host. If a key is given, it is used to construct the
3870 domain for the lookup. For example:
3872 dsn.rfc-ignorant.org/$sender_address_domain
3874 After finding a match in the DNS, the domain is placed in $dnslist_domain, and
3875 then we check for a TXT record for an error message, and if found, save its
3876 value in $dnslist_text. We also cache everything in a tree, to optimize
3879 The TXT record is normally looked up in the same domain as the A record, but
3880 when many lists are combined in a single DNS domain, this will not be a very
3881 specific message. It is possible to specify a different domain for looking up
3882 TXT records; this is given before the main domain, comma-separated. For
3885 dnslists = http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
3886 socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3
3888 The caching ensures that only one lookup in dnsbl.sorbs.net is done.
3890 Note: an address for testing RBL is 192.203.178.39
3891 Note: an address for testing DUL is 192.203.178.4
3892 Note: a domain for testing RFCI is example.tld.dsn.rfc-ignorant.org
3896 listptr the domain/address/data list
3897 log_msgptr log message on error
3899 Returns: OK successful lookup (i.e. the address is on the list), or
3900 lookup deferred after +include_unknown
3901 FAIL name not found, or no data found for the given type, or
3902 lookup deferred after +exclude_unknown (default)
3903 DEFER lookup failure, if +defer_unknown was set
3907 verify_check_dnsbl(int where, const uschar ** listptr, uschar ** log_msgptr)
3910 int defer_return = FAIL;
3911 const uschar *list = *listptr;
3914 uschar buffer[1024];
3915 uschar revadd[128]; /* Long enough for IPv6 address */
3917 /* Indicate that the inverted IP address is not yet set up */
3921 /* In case this is the first time the DNS resolver is being used. */
3923 dns_init(FALSE, FALSE, FALSE); /*XXX dnssec? */
3925 /* Loop through all the domains supplied, until something matches */
3927 while ((domain = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
3930 BOOL bitmask = FALSE;
3937 HDEBUG(D_dnsbl) debug_printf("DNS list check: %s\n", domain);
3939 /* Deal with special values that change the behaviour on defer */
3941 if (domain[0] == '+')
3943 if (strcmpic(domain, US"+include_unknown") == 0) defer_return = OK;
3944 else if (strcmpic(domain, US"+exclude_unknown") == 0) defer_return = FAIL;
3945 else if (strcmpic(domain, US"+defer_unknown") == 0) defer_return = DEFER;
3947 log_write(0, LOG_MAIN|LOG_PANIC, "unknown item in dnslist (ignored): %s",
3952 /* See if there's explicit data to be looked up */
3954 if ((key = Ustrchr(domain, '/'))) *key++ = 0;
3956 /* See if there's a list of addresses supplied after the domain name. This is
3957 introduced by an = or a & character; if preceded by = we require all matches
3958 and if preceded by ! we invert the result. */
3960 if (!(iplist = Ustrchr(domain, '=')))
3963 iplist = Ustrchr(domain, '&');
3966 if (iplist) /* Found either = or & */
3968 if (iplist > domain && iplist[-1] == '!') /* Handle preceding ! */
3970 match_type |= MT_NOT;
3974 *iplist++ = 0; /* Terminate domain, move on */
3976 /* If we found = (bitmask == FALSE), check for == or =& */
3978 if (!bitmask && (*iplist == '=' || *iplist == '&'))
3980 bitmask = *iplist++ == '&';
3981 match_type |= MT_ALL;
3986 /* If there is a comma in the domain, it indicates that a second domain for
3987 looking up TXT records is provided, before the main domain. Otherwise we must
3988 set domain_txt == domain. */
3990 domain_txt = domain;
3991 comma = Ustrchr(domain, ',');
3998 /* Check that what we have left is a sensible domain name. There is no reason
3999 why these domains should in fact use the same syntax as hosts and email
4000 domains, but in practice they seem to. However, there is little point in
4001 actually causing an error here, because that would no doubt hold up incoming
4002 mail. Instead, I'll just log it. */
4004 for (s = domain; *s != 0; s++)
4006 if (!isalnum(*s) && *s != '-' && *s != '.' && *s != '_')
4008 log_write(0, LOG_MAIN, "dnslists domain \"%s\" contains "
4009 "strange characters - is this right?", domain);
4014 /* Check the alternate domain if present */
4016 if (domain_txt != domain) for (s = domain_txt; *s != 0; s++)
4018 if (!isalnum(*s) && *s != '-' && *s != '.' && *s != '_')
4020 log_write(0, LOG_MAIN, "dnslists domain \"%s\" contains "
4021 "strange characters - is this right?", domain_txt);
4026 /* If there is no key string, construct the query by adding the domain name
4027 onto the inverted host address, and perform a single DNS lookup. */
4031 if (where == ACL_WHERE_NOTSMTP_START || where == ACL_WHERE_NOTSMTP)
4033 *log_msgptr = string_sprintf
4034 ("cannot test auto-keyed dnslists condition in %s ACL",
4035 acl_wherenames[where]);
4038 if (sender_host_address == NULL) return FAIL; /* can never match */
4039 if (revadd[0] == 0) invert_address(revadd, sender_host_address);
4040 rc = one_check_dnsbl(domain, domain_txt, sender_host_address, revadd,
4041 iplist, bitmask, match_type, defer_return);
4044 dnslist_domain = string_copy(domain_txt);
4045 dnslist_matched = string_copy(sender_host_address);
4046 HDEBUG(D_dnsbl) debug_printf("=> that means %s is listed at %s\n",
4047 sender_host_address, dnslist_domain);
4049 if (rc != FAIL) return rc; /* OK or DEFER */
4052 /* If there is a key string, it can be a list of domains or IP addresses to
4053 be concatenated with the main domain. */
4060 uschar keybuffer[256];
4061 uschar keyrevadd[128];
4063 while ((keydomain = string_nextinlist(CUSS &key, &keysep, keybuffer,
4064 sizeof(keybuffer))) != NULL)
4066 uschar *prepend = keydomain;
4068 if (string_is_ip_address(keydomain, NULL) != 0)
4070 invert_address(keyrevadd, keydomain);
4071 prepend = keyrevadd;
4074 rc = one_check_dnsbl(domain, domain_txt, keydomain, prepend, iplist,
4075 bitmask, match_type, defer_return);
4079 dnslist_domain = string_copy(domain_txt);
4080 dnslist_matched = string_copy(keydomain);
4081 HDEBUG(D_dnsbl) debug_printf("=> that means %s is listed at %s\n",
4082 keydomain, dnslist_domain);
4086 /* If the lookup deferred, remember this fact. We keep trying the rest
4087 of the list to see if we get a useful result, and if we don't, we return
4088 DEFER at the end. */
4090 if (rc == DEFER) defer = TRUE;
4091 } /* continue with next keystring domain/address */
4093 if (defer) return DEFER;
4095 } /* continue with next dnsdb outer domain */
4102 /* End of verify.c */