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. */
229 if (dbm_file != NULL)
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. */
240 if (cache_record != NULL)
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. */
300 if (pm_mailfrom != NULL)
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 != NULL)
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 != NULL && !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 != NULL && !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. */
547 if (host->address == NULL)
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. */
662 if (tf->helo_data != NULL)
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 tls_offered = !!(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;
812 ob->command_timeout = callout;
813 rc = tls_client_start(inblock.sock, host, addr, addr->transport
814 # ifdef EXPERIMENTAL_DANE
815 , dane ? &tlsa_dnsa : NULL
818 ob->command_timeout = oldtimeout;
820 /* TLS negotiation failed; give an error. Try in clear on a new
821 connection, if the options permit it for this host. */
826 (void)close(inblock.sock);
827 # ifndef DISABLE_EVENT
828 (void) event_raise(addr->transport->event_action,
829 US"tcp:close", NULL);
831 if ( ob->tls_tempfail_tryclear
833 && verify_check_given_host(&ob->hosts_require_tls, host) != OK
836 log_write(0, LOG_MAIN, "TLS session failure:"
837 " delivering unencrypted to %s [%s] (not in hosts_require_tls)",
838 host->name, host->address);
840 goto tls_retry_connection;
844 /*save_errno = ERRNO_TLSFAILURE;*/
845 /*message = US"failure while setting up TLS session";*/
851 /* TLS session is set up. Copy info for logging. */
852 addr->cipher = tls_out.cipher;
853 addr->peerdn = tls_out.peerdn;
855 /* For SMTPS we need to wait for the initial OK response, then do HELO. */
857 goto smtps_redo_greeting;
859 /* For STARTTLS we need to redo EHLO */
864 /* If the host is required to use a secure channel, ensure that we have one. */
865 if (tls_out.active < 0)
867 # ifdef EXPERIMENTAL_DANE
870 verify_check_given_host(&ob->hosts_require_tls, host) == OK
873 /*save_errno = ERRNO_TLSREQUIRED;*/
874 log_write(0, LOG_MAIN,
875 "H=%s [%s]: a TLS session is required for this host, but %s",
876 host->name, host->address,
877 peer_offered & PEER_OFFERED_TLS
878 ? "an attempt to start TLS failed"
879 : "the server did not offer TLS support");
884 #endif /*SUPPORT_TLS*/
886 done = TRUE; /* so far so good; have response to HELO */
888 /* For now, transport_filter by cutthrough-delivery is not supported */
889 /* Need proper integration with the proper transport mechanism. */
890 if (cutthrough.delivery)
893 if (addr->transport->filter_command)
895 cutthrough.delivery = FALSE;
896 HDEBUG(D_acl|D_v) debug_printf("Cutthrough cancelled by presence of transport filter\n");
899 else if ((s = ob->dkim_domain) && (s = expand_string(s)) && *s)
901 cutthrough.delivery = FALSE;
902 HDEBUG(D_acl|D_v) debug_printf("Cutthrough cancelled by presence of DKIM signing\n");
911 /* Clear down of the TLS, SMTP and TCP layers on error is handled below. */
913 /* Failure to accept HELO is cached; this blocks the whole domain for all
914 senders. I/O errors and defer responses are not cached. */
918 *failure_ptr = US"mail"; /* At or before MAIL */
919 if (errno == 0 && responsebuffer[0] == '5')
921 setflag(addr, af_verify_nsfail);
922 new_domain_record.result = ccache_reject;
927 else if ( addr->prop.utf8_msg
928 && !addr->prop.utf8_downcvt
929 && !(peer_offered & PEER_OFFERED_UTF8)
932 HDEBUG(D_acl|D_v) debug_printf("utf8 required but not offered\n");
933 errno = ERRNO_UTF8_FWD;
934 setflag(addr, af_verify_nsfail);
937 else if ( addr->prop.utf8_msg
938 && (addr->prop.utf8_downcvt || !(peer_offered & PEER_OFFERED_UTF8))
939 && (setflag(addr, af_utf8_downcvt),
940 from_address = string_address_utf8_to_alabel(from_address,
945 errno = ERRNO_EXPANDFAIL;
946 setflag(addr, af_verify_nsfail);
951 /* If we haven't authenticated, but are required to, give up. */
954 else done = smtp_auth(responsebuffer, sizeof(responsebuffer),
955 addr, host, ob, esmtp, &inblock, &outblock) == OK &&
957 /* Copy AUTH info for logging */
958 ( (addr->authenticator = client_authenticator),
959 (addr->auth_id = client_authenticated_id),
961 /* Build a mail-AUTH string (re-using responsebuffer for convenience */
962 !smtp_mail_auth_str(responsebuffer, sizeof(responsebuffer), addr, ob)
965 ( (addr->auth_sndr = client_authenticated_sender),
967 /* Send the MAIL command */
968 (smtp_write_command(&outblock, FALSE,
970 addr->prop.utf8_msg && !addr->prop.utf8_downcvt
971 ? "MAIL FROM:<%s>%s%s SMTPUTF8\r\n"
974 "MAIL FROM:<%s>%s%s\r\n",
975 from_address, responsebuffer, size_str) >= 0)
978 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
981 deliver_host = deliver_host_address = NULL;
982 deliver_domain = save_deliver_domain;
984 /* If the host does not accept MAIL FROM:<>, arrange to cache this
985 information, but again, don't record anything for an I/O error or a defer. Do
986 not cache rejections of MAIL when a non-empty sender has been used, because
987 that blocks the whole domain for all senders. */
991 *failure_ptr = US"mail"; /* At or before MAIL */
992 if (errno == 0 && responsebuffer[0] == '5')
994 setflag(addr, af_verify_nsfail);
995 if (from_address[0] == 0)
996 new_domain_record.result = ccache_reject_mfnull;
1000 /* Otherwise, proceed to check a "random" address (if required), then the
1001 given address, and the postmaster address (if required). Between each check,
1002 issue RSET, because some servers accept only one recipient after MAIL
1005 Before doing this, set the result in the domain cache record to "accept",
1006 unless its previous value was ccache_reject_mfnull. In that case, the domain
1007 rejects MAIL FROM:<> and we want to continue to remember that. When that is
1008 the case, we have got here only in the case of a recipient verification with
1009 a non-null sender. */
1013 const uschar * rcpt_domain = addr->domain;
1016 uschar * errstr = NULL;
1017 if ( testflag(addr, af_utf8_downcvt)
1018 && (rcpt_domain = string_domain_utf8_to_alabel(rcpt_domain,
1022 addr->message = errstr;
1023 errno = ERRNO_EXPANDFAIL;
1024 setflag(addr, af_verify_nsfail);
1026 rcpt_domain = US""; /*XXX errorhandling! */
1030 new_domain_record.result =
1031 (old_domain_cache_result == ccache_reject_mfnull)?
1032 ccache_reject_mfnull: ccache_accept;
1034 /* Do the random local part check first */
1036 if (random_local_part != NULL)
1038 uschar randombuffer[1024];
1040 smtp_write_command(&outblock, FALSE,
1041 "RCPT TO:<%.1000s@%.1000s>\r\n", random_local_part,
1042 rcpt_domain) >= 0 &&
1043 smtp_read_response(&inblock, randombuffer,
1044 sizeof(randombuffer), '2', callout);
1046 /* Remember when we last did a random test */
1048 new_domain_record.random_stamp = time(NULL);
1050 /* If accepted, we aren't going to do any further tests below. */
1053 new_domain_record.random_result = ccache_accept;
1055 /* Otherwise, cache a real negative response, and get back to the right
1056 state to send RCPT. Unless there's some problem such as a dropped
1057 connection, we expect to succeed, because the commands succeeded above.
1058 However, some servers drop the connection after responding to an
1059 invalid recipient, so on (any) error we drop and remake the connection.
1062 else if (errno == 0)
1064 /* This would be ok for 1st rcpt a cutthrough, but no way to
1065 handle a subsequent. So refuse to support any */
1066 cancel_cutthrough_connection("random-recipient");
1068 if (randombuffer[0] == '5')
1069 new_domain_record.random_result = ccache_reject;
1072 smtp_write_command(&outblock, FALSE, "RSET\r\n") >= 0 &&
1073 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
1076 smtp_write_command(&outblock, FALSE,
1078 addr->prop.utf8_msg && !addr->prop.utf8_downcvt
1079 ? "MAIL FROM:<%s> SMTPUTF8\r\n"
1082 "MAIL FROM:<%s>\r\n",
1083 from_address) >= 0 &&
1084 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
1090 debug_printf("problem after random/rset/mfrom; reopen conn\n");
1091 random_local_part = NULL;
1093 tls_close(FALSE, TRUE);
1095 (void)close(inblock.sock);
1096 #ifndef DISABLE_EVENT
1097 (void) event_raise(addr->transport->event_action,
1098 US"tcp:close", NULL);
1100 goto tls_retry_connection;
1103 else done = FALSE; /* Some timeout/connection problem */
1104 } /* Random check */
1106 /* If the host is accepting all local parts, as determined by the "random"
1107 check, we don't need to waste time doing any further checking. */
1109 if (new_domain_record.random_result != ccache_accept && done)
1111 /* Get the rcpt_include_affixes flag from the transport if there is one,
1112 but assume FALSE if there is not. */
1114 uschar * rcpt = transport_rcpt_address(addr,
1115 addr->transport ? addr->transport->rcpt_include_affixes : FALSE);
1118 /*XXX should the conversion be moved into transport_rcpt_address() ? */
1119 uschar * dummy_errstr = NULL;
1120 if ( testflag(addr, af_utf8_downcvt)
1121 && (rcpt = string_address_utf8_to_alabel(rcpt, &dummy_errstr),
1125 errno = ERRNO_EXPANDFAIL;
1126 *failure_ptr = US"recipient";
1133 smtp_write_command(&outblock, FALSE, "RCPT TO:<%.1000s>\r\n",
1135 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
1139 new_address_record.result = ccache_accept;
1140 else if (errno == 0 && responsebuffer[0] == '5')
1142 *failure_ptr = US"recipient";
1143 new_address_record.result = ccache_reject;
1146 /* Do postmaster check if requested; if a full check is required, we
1147 check for RCPT TO:<postmaster> (no domain) in accordance with RFC 821. */
1149 if (done && pm_mailfrom != NULL)
1151 /* Could possibly shift before main verify, just above, and be ok
1152 for cutthrough. But no way to handle a subsequent rcpt, so just
1154 cancel_cutthrough_connection("postmaster verify");
1155 HDEBUG(D_acl|D_v) debug_printf("Cutthrough cancelled by presence of postmaster verify\n");
1158 smtp_write_command(&outblock, FALSE, "RSET\r\n") >= 0 &&
1159 smtp_read_response(&inblock, responsebuffer,
1160 sizeof(responsebuffer), '2', callout) &&
1162 smtp_write_command(&outblock, FALSE,
1163 "MAIL FROM:<%s>\r\n", pm_mailfrom) >= 0 &&
1164 smtp_read_response(&inblock, responsebuffer,
1165 sizeof(responsebuffer), '2', callout) &&
1167 /* First try using the current domain */
1170 smtp_write_command(&outblock, FALSE,
1171 "RCPT TO:<postmaster@%.1000s>\r\n", rcpt_domain) >= 0 &&
1172 smtp_read_response(&inblock, responsebuffer,
1173 sizeof(responsebuffer), '2', callout)
1178 /* If that doesn't work, and a full check is requested,
1179 try without the domain. */
1182 (options & vopt_callout_fullpm) != 0 &&
1183 smtp_write_command(&outblock, FALSE,
1184 "RCPT TO:<postmaster>\r\n") >= 0 &&
1185 smtp_read_response(&inblock, responsebuffer,
1186 sizeof(responsebuffer), '2', callout)
1189 /* Sort out the cache record */
1191 new_domain_record.postmaster_stamp = time(NULL);
1194 new_domain_record.postmaster_result = ccache_accept;
1195 else if (errno == 0 && responsebuffer[0] == '5')
1197 *failure_ptr = US"postmaster";
1198 setflag(addr, af_verify_pmfail);
1199 new_domain_record.postmaster_result = ccache_reject;
1202 } /* Random not accepted */
1203 } /* MAIL FROM: accepted */
1205 /* For any failure of the main check, other than a negative response, we just
1206 close the connection and carry on. We can identify a negative response by the
1207 fact that errno is zero. For I/O errors it will be non-zero
1209 Set up different error texts for logging and for sending back to the caller
1210 as an SMTP response. Log in all cases, using a one-line format. For sender
1211 callouts, give a full response to the caller, but for recipient callouts,
1212 don't give the IP address because this may be an internal host whose identity
1213 is not to be widely broadcast. */
1217 if (errno == ETIMEDOUT)
1219 HDEBUG(D_verify) debug_printf("SMTP timeout\n");
1223 else if (errno == ERRNO_UTF8_FWD)
1225 extern int acl_where; /* src/acl.c */
1227 addr->message = string_sprintf(
1228 "response to \"%s\" from %s [%s] did not include SMTPUTF8",
1229 big_buffer, host->name, host->address);
1230 addr->user_message = acl_where == ACL_WHERE_RCPT
1231 ? US"533 mailbox name not allowed"
1232 : US"550 mailbox unavailable";
1237 else if (errno == 0)
1239 if (*responsebuffer == 0) Ustrcpy(responsebuffer, US"connection dropped");
1242 string_sprintf("response to \"%s\" from %s [%s] was: %s",
1243 big_buffer, host->name, host->address,
1244 string_printing(responsebuffer));
1246 addr->user_message = options & vopt_is_recipient
1247 ? string_sprintf("Callout verification failed:\n%s", responsebuffer)
1248 : string_sprintf("Called: %s\nSent: %s\nResponse: %s",
1249 host->address, big_buffer, responsebuffer);
1251 /* Hard rejection ends the process */
1253 if (responsebuffer[0] == '5') /* Address rejected */
1261 /* End the SMTP conversation and close the connection. */
1263 /* Cutthrough - on a successfull connect and recipient-verify with
1264 use-sender and we are 1st rcpt and have no cutthrough conn so far
1265 here is where we want to leave the conn open */
1266 if ( cutthrough.delivery
1270 && (options & (vopt_callout_recipsender|vopt_callout_recippmaster|vopt_success_on_redirect))
1271 == vopt_callout_recipsender
1272 && !random_local_part
1274 && cutthrough.fd < 0
1278 HDEBUG(D_acl|D_v) debug_printf("holding verify callout open for cutthrough delivery\n");
1280 cutthrough.fd = outblock.sock; /* We assume no buffer in use in the outblock */
1281 cutthrough.nrcpt = 1;
1282 cutthrough.interface = interface;
1283 cutthrough.host = *host;
1284 cutthrough.addr = *addr; /* Save the address_item for later logging */
1285 cutthrough.addr.next = NULL;
1286 cutthrough.addr.host_used = &cutthrough.host;
1288 *(cutthrough.addr.parent = store_get(sizeof(address_item))) =
1290 ctblock.buffer = ctbuffer;
1291 ctblock.buffersize = sizeof(ctbuffer);
1292 ctblock.ptr = ctbuffer;
1293 /* ctblock.cmd_count = 0; ctblock.authenticating = FALSE; */
1294 ctblock.sock = cutthrough.fd;
1298 /* Ensure no cutthrough on multiple address verifies */
1299 if (options & vopt_callout_recipsender)
1300 cancel_cutthrough_connection("multiple verify calls");
1301 if (send_quit) (void)smtp_write_command(&outblock, FALSE, "QUIT\r\n");
1304 tls_close(FALSE, TRUE);
1306 (void)close(inblock.sock);
1307 #ifndef DISABLE_EVENT
1308 (void) event_raise(addr->transport->event_action, US"tcp:close", NULL);
1312 } /* Loop through all hosts, while !done */
1315 /* If we get here with done == TRUE, a successful callout happened, and yield
1316 will be set OK or FAIL according to the response to the RCPT command.
1317 Otherwise, we looped through the hosts but couldn't complete the business.
1318 However, there may be domain-specific information to cache in both cases.
1320 The value of the result field in the new_domain record is ccache_unknown if
1321 there was an error before or with MAIL FROM:, and errno was not zero,
1322 implying some kind of I/O error. We don't want to write the cache in that case.
1323 Otherwise the value is ccache_accept, ccache_reject, or ccache_reject_mfnull. */
1325 if ( !(options & vopt_callout_no_cache)
1326 && new_domain_record.result != ccache_unknown)
1328 if ((dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE))
1331 HDEBUG(D_verify) debug_printf("callout cache: not available\n");
1335 (void)dbfn_write(dbm_file, addr->domain, &new_domain_record,
1336 (int)sizeof(dbdata_callout_cache));
1337 HDEBUG(D_verify) debug_printf("wrote callout cache domain record for %s:\n"
1338 " result=%d postmaster=%d random=%d\n",
1340 new_domain_record.result,
1341 new_domain_record.postmaster_result,
1342 new_domain_record.random_result);
1346 /* If a definite result was obtained for the callout, cache it unless caching
1351 if ( !(options & vopt_callout_no_cache)
1352 && new_address_record.result != ccache_unknown)
1354 if (dbm_file == NULL)
1355 dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE);
1356 if (dbm_file == NULL)
1358 HDEBUG(D_verify) debug_printf("no callout cache available\n");
1362 (void)dbfn_write(dbm_file, address_key, &new_address_record,
1363 (int)sizeof(dbdata_callout_cache_address));
1364 HDEBUG(D_verify) debug_printf("wrote %s callout cache address record for %s\n",
1365 new_address_record.result == ccache_accept ? "positive" : "negative",
1371 /* Failure to connect to any host, or any response other than 2xx or 5xx is a
1372 temporary error. If there was only one host, and a response was received, leave
1373 it alone if supplying details. Otherwise, give a generic response. */
1377 uschar *dullmsg = string_sprintf("Could not complete %s verify callout",
1378 options & vopt_is_recipient ? "recipient" : "sender");
1381 if (host_list->next != NULL || addr->message == NULL) addr->message = dullmsg;
1383 addr->user_message = (!smtp_return_error_details)? dullmsg :
1384 string_sprintf("%s for <%s>.\n"
1385 "The mail server(s) for the domain may be temporarily unreachable, or\n"
1386 "they may be permanently unreachable from this server. In the latter case,\n%s",
1387 dullmsg, addr->address,
1388 options & vopt_is_recipient
1389 ? "the address will never be accepted."
1390 : "you need to change the address or create an MX record for its domain\n"
1391 "if it is supposed to be generally accessible from the Internet.\n"
1392 "Talk to your mail administrator for details.");
1394 /* Force a specific error code */
1396 addr->basic_errno = ERRNO_CALLOUTDEFER;
1399 /* Come here from within the cache-reading code on fast-track exit. */
1402 if (dbm_file != NULL) dbfn_close(dbm_file);
1408 /* Called after recipient-acl to get a cutthrough connection open when
1409 one was requested and a recipient-verify wasn't subsequently done.
1412 open_cutthrough_connection( address_item * addr )
1417 /* Use a recipient-verify-callout to set up the cutthrough connection. */
1418 /* We must use a copy of the address for verification, because it might
1422 HDEBUG(D_acl) debug_printf("----------- %s cutthrough setup ------------\n",
1423 rcpt_count > 1 ? "more" : "start");
1424 rc= verify_address(&addr2, NULL,
1425 vopt_is_recipient | vopt_callout_recipsender | vopt_callout_no_cache,
1426 CUTTHROUGH_CMD_TIMEOUT, -1, -1,
1428 HDEBUG(D_acl) debug_printf("----------- end cutthrough setup ------------\n");
1434 /* Send given number of bytes from the buffer */
1436 cutthrough_send(int n)
1438 if(cutthrough.fd < 0)
1443 (tls_out.active == cutthrough.fd) ? tls_write(FALSE, ctblock.buffer, n) :
1445 send(cutthrough.fd, ctblock.buffer, n, 0) > 0
1448 transport_count += n;
1449 ctblock.ptr= ctblock.buffer;
1453 HDEBUG(D_transport|D_acl) debug_printf("cutthrough_send failed: %s\n", strerror(errno));
1460 _cutthrough_puts(uschar * cp, int n)
1464 if(ctblock.ptr >= ctblock.buffer+ctblock.buffersize)
1465 if(!cutthrough_send(ctblock.buffersize))
1468 *ctblock.ptr++ = *cp++;
1473 /* Buffered output of counted data block. Return boolean success */
1475 cutthrough_puts(uschar * cp, int n)
1477 if (cutthrough.fd < 0) return TRUE;
1478 if (_cutthrough_puts(cp, n)) return TRUE;
1479 cancel_cutthrough_connection("transmit failed");
1485 _cutthrough_flush_send(void)
1487 int n= ctblock.ptr-ctblock.buffer;
1490 if(!cutthrough_send(n))
1496 /* Send out any bufferred output. Return boolean success. */
1498 cutthrough_flush_send(void)
1500 if (_cutthrough_flush_send()) return TRUE;
1501 cancel_cutthrough_connection("transmit failed");
1507 cutthrough_put_nl(void)
1509 return cutthrough_puts(US"\r\n", 2);
1513 /* Get and check response from cutthrough target */
1515 cutthrough_response(char expect, uschar ** copy)
1517 smtp_inblock inblock;
1518 uschar inbuffer[4096];
1519 uschar responsebuffer[4096];
1521 inblock.buffer = inbuffer;
1522 inblock.buffersize = sizeof(inbuffer);
1523 inblock.ptr = inbuffer;
1524 inblock.ptrend = inbuffer;
1525 inblock.sock = cutthrough.fd;
1526 /* this relies on (inblock.sock == tls_out.active) */
1527 if(!smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer), expect, CUTTHROUGH_DATA_TIMEOUT))
1528 cancel_cutthrough_connection("target timeout on read");
1533 *copy = cp = string_copy(responsebuffer);
1534 /* Trim the trailing end of line */
1535 cp += Ustrlen(responsebuffer);
1536 if(cp > *copy && cp[-1] == '\n') *--cp = '\0';
1537 if(cp > *copy && cp[-1] == '\r') *--cp = '\0';
1540 return responsebuffer[0];
1544 /* Negotiate dataphase with the cutthrough target, returning success boolean */
1546 cutthrough_predata(void)
1548 if(cutthrough.fd < 0)
1551 HDEBUG(D_transport|D_acl|D_v) debug_printf(" SMTP>> DATA\n");
1552 cutthrough_puts(US"DATA\r\n", 6);
1553 cutthrough_flush_send();
1555 /* Assume nothing buffered. If it was it gets ignored. */
1556 return cutthrough_response('3', NULL) == '3';
1560 /* fd and use_crlf args only to match write_chunk() */
1562 cutthrough_write_chunk(int fd, uschar * s, int len, BOOL use_crlf)
1565 while(s && (s2 = Ustrchr(s, '\n')))
1567 if(!cutthrough_puts(s, s2-s) || !cutthrough_put_nl())
1575 /* Buffered send of headers. Return success boolean. */
1576 /* Expands newlines to wire format (CR,NL). */
1577 /* Also sends header-terminating blank line. */
1579 cutthrough_headers_send(void)
1581 if(cutthrough.fd < 0)
1584 /* We share a routine with the mainline transport to handle header add/remove/rewrites,
1585 but having a separate buffered-output function (for now)
1587 HDEBUG(D_acl) debug_printf("----------- start cutthrough headers send -----------\n");
1589 if (!transport_headers_send(&cutthrough.addr, cutthrough.fd,
1590 cutthrough.addr.transport->add_headers,
1591 cutthrough.addr.transport->remove_headers,
1592 &cutthrough_write_chunk, TRUE,
1593 cutthrough.addr.transport->rewrite_rules,
1594 cutthrough.addr.transport->rewrite_existflags))
1597 HDEBUG(D_acl) debug_printf("----------- done cutthrough headers send ------------\n");
1603 close_cutthrough_connection(const char * why)
1605 if(cutthrough.fd >= 0)
1607 /* We could be sending this after a bunch of data, but that is ok as
1608 the only way to cancel the transfer in dataphase is to drop the tcp
1609 conn before the final dot.
1611 ctblock.ptr = ctbuffer;
1612 HDEBUG(D_transport|D_acl|D_v) debug_printf(" SMTP>> QUIT\n");
1613 _cutthrough_puts(US"QUIT\r\n", 6); /* avoid recursion */
1614 _cutthrough_flush_send();
1615 /* No wait for response */
1618 tls_close(FALSE, TRUE);
1620 (void)close(cutthrough.fd);
1622 HDEBUG(D_acl) debug_printf("----------- cutthrough shutdown (%s) ------------\n", why);
1624 ctblock.ptr = ctbuffer;
1628 cancel_cutthrough_connection(const char * why)
1630 close_cutthrough_connection(why);
1631 cutthrough.delivery = FALSE;
1637 /* Have senders final-dot. Send one to cutthrough target, and grab the response.
1638 Log an OK response as a transmission.
1639 Close the connection.
1640 Return smtp response-class digit.
1643 cutthrough_finaldot(void)
1646 address_item * addr;
1647 HDEBUG(D_transport|D_acl|D_v) debug_printf(" SMTP>> .\n");
1649 /* Assume data finshed with new-line */
1650 if( !cutthrough_puts(US".", 1)
1651 || !cutthrough_put_nl()
1652 || !cutthrough_flush_send()
1654 return cutthrough.addr.message;
1656 res = cutthrough_response('2', &cutthrough.addr.message);
1657 for (addr = &cutthrough.addr; addr; addr = addr->next)
1659 addr->message = cutthrough.addr.message;
1663 delivery_log(LOG_MAIN, addr, (int)'>', NULL);
1664 close_cutthrough_connection("delivered");
1668 delivery_log(LOG_MAIN, addr, 0,
1669 US"tmp-reject from cutthrough after DATA:");
1673 delivery_log(LOG_MAIN|LOG_REJECT, addr, 0,
1674 US"rejected after DATA:");
1681 return cutthrough.addr.message;
1686 /*************************************************
1687 * Copy error to toplevel address *
1688 *************************************************/
1690 /* This function is used when a verify fails or defers, to ensure that the
1691 failure or defer information is in the original toplevel address. This applies
1692 when an address is redirected to a single new address, and the failure or
1693 deferral happens to the child address.
1696 vaddr the verify address item
1697 addr the final address item
1700 Returns: the value of YIELD
1704 copy_error(address_item *vaddr, address_item *addr, int yield)
1708 vaddr->message = addr->message;
1709 vaddr->user_message = addr->user_message;
1710 vaddr->basic_errno = addr->basic_errno;
1711 vaddr->more_errno = addr->more_errno;
1712 vaddr->prop.address_data = addr->prop.address_data;
1713 copyflag(vaddr, addr, af_pass_message);
1721 /**************************************************
1722 * printf that automatically handles TLS if needed *
1723 ***************************************************/
1725 /* This function is used by verify_address() as a substitute for all fprintf()
1726 calls; a direct fprintf() will not produce output in a TLS SMTP session, such
1727 as a response to an EXPN command. smtp_in.c makes smtp_printf available but
1728 that assumes that we always use the smtp_out FILE* when not using TLS or the
1729 ssl buffer when we are. Instead we take a FILE* parameter and check to see if
1730 that is smtp_out; if so, smtp_printf() with TLS support, otherwise regular
1734 f the candidate FILE* to write to
1735 format format string
1736 ... optional arguments
1742 static void PRINTF_FUNCTION(2,3)
1743 respond_printf(FILE *f, const char *format, ...)
1747 va_start(ap, format);
1748 if (smtp_out && (f == smtp_out))
1749 smtp_vprintf(format, ap);
1751 vfprintf(f, format, ap);
1757 /*************************************************
1758 * Verify an email address *
1759 *************************************************/
1761 /* This function is used both for verification (-bv and at other times) and
1762 address testing (-bt), which is indicated by address_test_mode being set.
1765 vaddr contains the address to verify; the next field in this block
1767 f if not NULL, write the result to this file
1768 options various option bits:
1769 vopt_fake_sender => this sender verify is not for the real
1770 sender (it was verify=sender=xxxx or an address from a
1771 header line) - rewriting must not change sender_address
1772 vopt_is_recipient => this is a recipient address, otherwise
1773 it's a sender address - this affects qualification and
1774 rewriting and messages from callouts
1775 vopt_qualify => qualify an unqualified address; else error
1776 vopt_expn => called from SMTP EXPN command
1777 vopt_success_on_redirect => when a new address is generated
1778 the verification instantly succeeds
1780 These ones are used by do_callout() -- the options variable
1783 vopt_callout_fullpm => if postmaster check, do full one
1784 vopt_callout_no_cache => don't use callout cache
1785 vopt_callout_random => do the "random" thing
1786 vopt_callout_recipsender => use real sender for recipient
1787 vopt_callout_recippmaster => use postmaster for recipient
1789 callout if > 0, specifies that callout is required, and gives timeout
1790 for individual commands
1791 callout_overall if > 0, gives overall timeout for the callout function;
1792 if < 0, a default is used (see do_callout())
1793 callout_connect the connection timeout for callouts
1794 se_mailfrom when callout is requested to verify a sender, use this
1795 in MAIL FROM; NULL => ""
1796 pm_mailfrom when callout is requested, if non-NULL, do the postmaster
1797 thing and use this as the sender address (may be "")
1799 routed if not NULL, set TRUE if routing succeeded, so we can
1800 distinguish between routing failed and callout failed
1802 Returns: OK address verified
1803 FAIL address failed to verify
1804 DEFER can't tell at present
1808 verify_address(address_item *vaddr, FILE *f, int options, int callout,
1809 int callout_overall, int callout_connect, uschar *se_mailfrom,
1810 uschar *pm_mailfrom, BOOL *routed)
1813 BOOL full_info = (f == NULL)? FALSE : (debug_selector != 0);
1814 BOOL expn = (options & vopt_expn) != 0;
1815 BOOL success_on_redirect = (options & vopt_success_on_redirect) != 0;
1818 int verify_type = expn? v_expn :
1819 address_test_mode? v_none :
1820 options & vopt_is_recipient? v_recipient : v_sender;
1821 address_item *addr_list;
1822 address_item *addr_new = NULL;
1823 address_item *addr_remote = NULL;
1824 address_item *addr_local = NULL;
1825 address_item *addr_succeed = NULL;
1826 uschar **failure_ptr = options & vopt_is_recipient
1827 ? &recipient_verify_failure : &sender_verify_failure;
1828 uschar *ko_prefix, *cr;
1829 uschar *address = vaddr->address;
1830 uschar *save_sender;
1831 uschar null_sender[] = { 0 }; /* Ensure writeable memory */
1833 /* Clear, just in case */
1835 *failure_ptr = NULL;
1837 /* Set up a prefix and suffix for error message which allow us to use the same
1838 output statements both in EXPN mode (where an SMTP response is needed) and when
1839 debugging with an output file. */
1843 ko_prefix = US"553 ";
1846 else ko_prefix = cr = US"";
1848 /* Add qualify domain if permitted; otherwise an unqualified address fails. */
1850 if (parse_find_at(address) == NULL)
1852 if ((options & vopt_qualify) == 0)
1855 respond_printf(f, "%sA domain is required for \"%s\"%s\n",
1856 ko_prefix, address, cr);
1857 *failure_ptr = US"qualify";
1860 address = rewrite_address_qualify(address, options & vopt_is_recipient);
1865 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
1866 debug_printf("%s %s\n", address_test_mode? "Testing" : "Verifying", address);
1869 /* Rewrite and report on it. Clear the domain and local part caches - these
1870 may have been set by domains and local part tests during an ACL. */
1872 if (global_rewrite_rules != NULL)
1874 uschar *old = address;
1875 address = rewrite_address(address, options & vopt_is_recipient, FALSE,
1876 global_rewrite_rules, rewrite_existflags);
1879 for (i = 0; i < (MAX_NAMED_LIST * 2)/32; i++) vaddr->localpart_cache[i] = 0;
1880 for (i = 0; i < (MAX_NAMED_LIST * 2)/32; i++) vaddr->domain_cache[i] = 0;
1881 if (f != NULL && !expn) fprintf(f, "Address rewritten as: %s\n", address);
1885 /* If this is the real sender address, we must update sender_address at
1886 this point, because it may be referred to in the routers. */
1888 if ((options & (vopt_fake_sender|vopt_is_recipient)) == 0)
1889 sender_address = address;
1891 /* If the address was rewritten to <> no verification can be done, and we have
1892 to return OK. This rewriting is permitted only for sender addresses; for other
1893 addresses, such rewriting fails. */
1895 if (address[0] == 0) return OK;
1897 /* Flip the legacy TLS-related variables over to the outbound set in case
1898 they're used in the context of a transport used by verification. Reset them
1899 at exit from this routine (so no returns allowed from here on). */
1901 tls_modify_variables(&tls_out);
1903 /* Save a copy of the sender address for re-instating if we change it to <>
1904 while verifying a sender address (a nice bit of self-reference there). */
1906 save_sender = sender_address;
1908 /* Observability variable for router/transport use */
1910 verify_mode = options & vopt_is_recipient ? US"R" : US"S";
1912 /* Update the address structure with the possibly qualified and rewritten
1913 address. Set it up as the starting address on the chain of new addresses. */
1915 vaddr->address = address;
1918 /* We need a loop, because an address can generate new addresses. We must also
1919 cope with generated pipes and files at the top level. (See also the code and
1920 comment in deliver.c.) However, it is usually the case that the router for
1921 user's .forward files has its verify flag turned off.
1923 If an address generates more than one child, the loop is used only when
1924 full_info is set, and this can only be set locally. Remote enquiries just get
1925 information about the top level address, not anything that it generated. */
1930 address_item *addr = addr_new;
1932 addr_new = addr->next;
1937 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
1938 debug_printf("Considering %s\n", addr->address);
1941 /* Handle generated pipe, file or reply addresses. We don't get these
1942 when handling EXPN, as it does only one level of expansion. */
1944 if (testflag(addr, af_pfr))
1951 if (addr->address[0] == '>')
1953 allow = testflag(addr, af_allow_reply);
1954 fprintf(f, "%s -> mail %s", addr->parent->address, addr->address + 1);
1958 allow = (addr->address[0] == '|')?
1959 testflag(addr, af_allow_pipe) : testflag(addr, af_allow_file);
1960 fprintf(f, "%s -> %s", addr->parent->address, addr->address);
1963 if (addr->basic_errno == ERRNO_BADTRANSPORT)
1964 fprintf(f, "\n*** Error in setting up pipe, file, or autoreply:\n"
1965 "%s\n", addr->message);
1967 fprintf(f, "\n transport = %s\n", addr->transport->name);
1969 fprintf(f, " *** forbidden ***\n");
1974 /* Just in case some router parameter refers to it. */
1976 return_path = addr->prop.errors_address
1977 ? addr->prop.errors_address : sender_address;
1979 /* Split the address into domain and local part, handling the %-hack if
1980 necessary, and then route it. While routing a sender address, set
1981 $sender_address to <> because that is what it will be if we were trying to
1982 send a bounce to the sender. */
1984 if (routed) *routed = FALSE;
1985 if ((rc = deliver_split_address(addr)) == OK)
1987 if (!(options & vopt_is_recipient)) sender_address = null_sender;
1988 rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
1989 &addr_succeed, verify_type);
1990 sender_address = save_sender; /* Put back the real sender */
1993 /* If routing an address succeeded, set the flag that remembers, for use when
1994 an ACL cached a sender verify (in case a callout fails). Then if routing set
1995 up a list of hosts or the transport has a host list, and the callout option
1996 is set, and we aren't in a host checking run, do the callout verification,
1997 and set another flag that notes that a callout happened. */
2001 if (routed) *routed = TRUE;
2004 transport_instance * tp;
2005 host_item * host_list = addr->host_list;
2007 /* Make up some data for use in the case where there is no remote
2010 transport_feedback tf = {
2011 NULL, /* interface (=> any) */
2012 US"smtp", /* port */
2013 US"smtp", /* protocol */
2015 US"$smtp_active_hostname", /* helo_data */
2016 FALSE, /* hosts_override */
2017 FALSE, /* hosts_randomize */
2018 FALSE, /* gethostbyname */
2019 TRUE, /* qualify_single */
2020 FALSE /* search_parents */
2023 /* If verification yielded a remote transport, we want to use that
2024 transport's options, so as to mimic what would happen if we were really
2025 sending a message to this address. */
2027 if ((tp = addr->transport) && !tp->info->local)
2029 (void)(tp->setup)(tp, addr, &tf, 0, 0, NULL);
2031 /* If the transport has hosts and the router does not, or if the
2032 transport is configured to override the router's hosts, we must build a
2033 host list of the transport's hosts, and find the IP addresses */
2035 if (tf.hosts && (!host_list || tf.hosts_override))
2038 const uschar *save_deliver_domain = deliver_domain;
2039 uschar *save_deliver_localpart = deliver_localpart;
2041 host_list = NULL; /* Ignore the router's hosts */
2043 deliver_domain = addr->domain;
2044 deliver_localpart = addr->local_part;
2045 s = expand_string(tf.hosts);
2046 deliver_domain = save_deliver_domain;
2047 deliver_localpart = save_deliver_localpart;
2051 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand list of hosts "
2052 "\"%s\" in %s transport for callout: %s", tf.hosts,
2053 tp->name, expand_string_message);
2058 host_item *host, *nexthost;
2059 host_build_hostlist(&host_list, s, tf.hosts_randomize);
2061 /* Just ignore failures to find a host address. If we don't manage
2062 to find any addresses, the callout will defer. Note that more than
2063 one address may be found for a single host, which will result in
2064 additional host items being inserted into the chain. Hence we must
2065 save the next host first. */
2067 flags = HOST_FIND_BY_A;
2068 if (tf.qualify_single) flags |= HOST_FIND_QUALIFY_SINGLE;
2069 if (tf.search_parents) flags |= HOST_FIND_SEARCH_PARENTS;
2071 for (host = host_list; host; host = nexthost)
2073 nexthost = host->next;
2074 if (tf.gethostbyname ||
2075 string_is_ip_address(host->name, NULL) != 0)
2076 (void)host_find_byname(host, NULL, flags, NULL, TRUE);
2079 dnssec_domains * dnssec_domains = NULL;
2080 if (Ustrcmp(tp->driver_name, "smtp") == 0)
2082 smtp_transport_options_block * ob =
2083 (smtp_transport_options_block *) tp->options_block;
2084 dnssec_domains = &ob->dnssec;
2087 (void)host_find_bydns(host, NULL, flags, NULL, NULL, NULL,
2088 dnssec_domains, NULL, NULL);
2095 /* Can only do a callout if we have at least one host! If the callout
2096 fails, it will have set ${sender,recipient}_verify_failure. */
2100 HDEBUG(D_verify) debug_printf("Attempting full verification using callout\n");
2101 if (host_checking && !host_checking_callout)
2104 debug_printf("... callout omitted by default when host testing\n"
2105 "(Use -bhc if you want the callouts to happen.)\n");
2110 deliver_set_expansions(addr);
2112 rc = do_callout(addr, host_list, &tf, callout, callout_overall,
2113 callout_connect, options, se_mailfrom, pm_mailfrom);
2118 HDEBUG(D_verify) debug_printf("Cannot do callout: neither router nor "
2119 "transport provided a host list\n");
2124 /* Otherwise, any failure is a routing failure */
2126 else *failure_ptr = US"route";
2128 /* A router may return REROUTED if it has set up a child address as a result
2129 of a change of domain name (typically from widening). In this case we always
2130 want to continue to verify the new child. */
2132 if (rc == REROUTED) continue;
2134 /* Handle hard failures */
2141 address_item *p = addr->parent;
2143 respond_printf(f, "%s%s %s", ko_prefix,
2144 full_info ? addr->address : address,
2145 address_test_mode ? "is undeliverable" : "failed to verify");
2146 if (!expn && admin_user)
2148 if (addr->basic_errno > 0)
2149 respond_printf(f, ": %s", strerror(addr->basic_errno));
2151 respond_printf(f, ": %s", addr->message);
2154 /* Show parents iff doing full info */
2156 if (full_info) while (p)
2158 respond_printf(f, "%s\n <-- %s", cr, p->address);
2161 respond_printf(f, "%s\n", cr);
2163 cancel_cutthrough_connection("routing hard fail");
2167 yield = copy_error(vaddr, addr, FAIL);
2175 else if (rc == DEFER)
2180 address_item *p = addr->parent;
2181 respond_printf(f, "%s%s cannot be resolved at this time", ko_prefix,
2182 full_info? addr->address : address);
2183 if (!expn && admin_user)
2185 if (addr->basic_errno > 0)
2186 respond_printf(f, ": %s", strerror(addr->basic_errno));
2188 respond_printf(f, ": %s", addr->message);
2189 else if (addr->basic_errno <= 0)
2190 respond_printf(f, ": unknown error");
2193 /* Show parents iff doing full info */
2195 if (full_info) while (p)
2197 respond_printf(f, "%s\n <-- %s", cr, p->address);
2200 respond_printf(f, "%s\n", cr);
2202 cancel_cutthrough_connection("routing soft fail");
2206 yield = copy_error(vaddr, addr, DEFER);
2209 if (yield == OK) yield = DEFER;
2212 /* If we are handling EXPN, we do not want to continue to route beyond
2213 the top level (whose address is in "address"). */
2217 uschar *ok_prefix = US"250-";
2220 if (!addr_local && !addr_remote)
2221 respond_printf(f, "250 mail to <%s> is discarded\r\n", address);
2223 respond_printf(f, "250 <%s>\r\n", address);
2227 address_item *addr2 = addr_new;
2228 addr_new = addr2->next;
2229 if (!addr_new) ok_prefix = US"250 ";
2230 respond_printf(f, "%s<%s>\r\n", ok_prefix, addr2->address);
2236 /* Successful routing other than EXPN. */
2240 /* Handle successful routing when short info wanted. Otherwise continue for
2241 other (generated) addresses. Short info is the operational case. Full info
2242 can be requested only when debug_selector != 0 and a file is supplied.
2244 There is a conflict between the use of aliasing as an alternate email
2245 address, and as a sort of mailing list. If an alias turns the incoming
2246 address into just one address (e.g. J.Caesar->jc44) you may well want to
2247 carry on verifying the generated address to ensure it is valid when
2248 checking incoming mail. If aliasing generates multiple addresses, you
2249 probably don't want to do this. Exim therefore treats the generation of
2250 just a single new address as a special case, and continues on to verify the
2251 generated address. */
2253 if ( !full_info /* Stop if short info wanted AND */
2254 && ( ( !addr_new /* No new address OR */
2255 || addr_new->next /* More than one new address OR */
2256 || testflag(addr_new, af_pfr) /* New address is pfr */
2259 ( addr_new /* At least one new address AND */
2260 && success_on_redirect /* success_on_redirect is set */
2264 if (f) fprintf(f, "%s %s\n",
2265 address, address_test_mode ? "is deliverable" : "verified");
2267 /* If we have carried on to verify a child address, we want the value
2268 of $address_data to be that of the child */
2270 vaddr->prop.address_data = addr->prop.address_data;
2272 /* If stopped because more than one new address, cannot cutthrough */
2274 if (addr_new && addr_new->next)
2275 cancel_cutthrough_connection("multiple addresses from routing");
2281 } /* Loop for generated addresses */
2283 /* Display the full results of the successful routing, including any generated
2284 addresses. Control gets here only when full_info is set, which requires f not
2285 to be NULL, and this occurs only when a top-level verify is called with the
2286 debugging switch on.
2288 If there are no local and no remote addresses, and there were no pipes, files,
2289 or autoreplies, and there were no errors or deferments, the message is to be
2290 discarded, usually because of the use of :blackhole: in an alias file. */
2292 if (allok && !addr_local && !addr_remote)
2294 fprintf(f, "mail to %s is discarded\n", address);
2298 for (addr_list = addr_local, i = 0; i < 2; addr_list = addr_remote, i++)
2301 address_item *addr = addr_list;
2302 address_item *p = addr->parent;
2303 transport_instance * tp = addr->transport;
2305 addr_list = addr->next;
2307 fprintf(f, "%s", CS addr->address);
2308 #ifdef EXPERIMENTAL_SRS
2309 if(addr->prop.srs_sender)
2310 fprintf(f, " [srs = %s]", addr->prop.srs_sender);
2313 /* If the address is a duplicate, show something about it. */
2315 if (!testflag(addr, af_pfr))
2318 if ((tnode = tree_search(tree_duplicates, addr->unique)))
2319 fprintf(f, " [duplicate, would not be delivered]");
2320 else tree_add_duplicate(addr->unique, addr);
2323 /* Now show its parents */
2325 for (p = addr->parent; p; p = p->parent)
2326 fprintf(f, "\n <-- %s", p->address);
2329 /* Show router, and transport */
2331 fprintf(f, "router = %s, transport = %s\n",
2332 addr->router->name, tp ? tp->name : US"unset");
2334 /* Show any hosts that are set up by a router unless the transport
2335 is going to override them; fiddle a bit to get a nice format. */
2337 if (addr->host_list && tp && !tp->overrides_hosts)
2342 for (h = addr->host_list; h; h = h->next)
2343 { /* get max lengths of host names, addrs */
2344 int len = Ustrlen(h->name);
2345 if (len > maxlen) maxlen = len;
2346 len = h->address ? Ustrlen(h->address) : 7;
2347 if (len > maxaddlen) maxaddlen = len;
2349 for (h = addr->host_list; h; h = h->next)
2351 fprintf(f, " host %-*s ", maxlen, h->name);
2354 fprintf(f, "[%s%-*c", h->address, maxaddlen+1 - Ustrlen(h->address), ']');
2355 else if (tp->info->local)
2356 fprintf(f, " %-*s ", maxaddlen, ""); /* Omit [unknown] for local */
2358 fprintf(f, "[%s%-*c", "unknown", maxaddlen+1 - 7, ']');
2360 if (h->mx >= 0) fprintf(f, " MX=%d", h->mx);
2361 if (h->port != PORT_NONE) fprintf(f, " port=%d", h->port);
2362 if (running_in_test_harness && h->dnssec == DS_YES) fputs(" AD", f);
2363 if (h->status == hstatus_unusable) fputs(" ** unusable **", f);
2369 /* Yield will be DEFER or FAIL if any one address has, only for full_info (which is
2370 the -bv or -bt case). */
2374 tls_modify_variables(&tls_in);
2382 /*************************************************
2383 * Check headers for syntax errors *
2384 *************************************************/
2386 /* This function checks those header lines that contain addresses, and verifies
2387 that all the addresses therein are syntactially correct.
2390 msgptr where to put an error message
2397 verify_check_headers(uschar **msgptr)
2403 for (h = header_list; h != NULL && yield == OK; h = h->next)
2405 if (h->type != htype_from &&
2406 h->type != htype_reply_to &&
2407 h->type != htype_sender &&
2408 h->type != htype_to &&
2409 h->type != htype_cc &&
2410 h->type != htype_bcc)
2413 colon = Ustrchr(h->text, ':');
2415 while (isspace(*s)) s++;
2417 /* Loop for multiple addresses in the header, enabling group syntax. Note
2418 that we have to reset this after the header has been scanned. */
2420 parse_allow_group = TRUE;
2424 uschar *ss = parse_find_address_end(s, FALSE);
2425 uschar *recipient, *errmess;
2426 int terminator = *ss;
2427 int start, end, domain;
2429 /* Temporarily terminate the string at this point, and extract the
2430 operative address within, allowing group syntax. */
2433 recipient = parse_extract_address(s,&errmess,&start,&end,&domain,FALSE);
2436 /* Permit an unqualified address only if the message is local, or if the
2437 sending host is configured to be permitted to send them. */
2439 if (recipient != NULL && domain == 0)
2441 if (h->type == htype_from || h->type == htype_sender)
2443 if (!allow_unqualified_sender) recipient = NULL;
2447 if (!allow_unqualified_recipient) recipient = NULL;
2449 if (recipient == NULL) errmess = US"unqualified address not permitted";
2452 /* It's an error if no address could be extracted, except for the special
2453 case of an empty address. */
2455 if (recipient == NULL && Ustrcmp(errmess, "empty address") != 0)
2457 uschar *verb = US"is";
2462 /* Arrange not to include any white space at the end in the
2463 error message or the header name. */
2465 while (t > s && isspace(t[-1])) t--;
2466 while (tt > h->text && isspace(tt[-1])) tt--;
2468 /* Add the address that failed to the error message, since in a
2469 header with very many addresses it is sometimes hard to spot
2470 which one is at fault. However, limit the amount of address to
2471 quote - cases have been seen where, for example, a missing double
2472 quote in a humungous To: header creates an "address" that is longer
2473 than string_sprintf can handle. */
2482 /* deconst cast ok as we're passing a non-const to string_printing() */
2483 *msgptr = US string_printing(
2484 string_sprintf("%s: failing address in \"%.*s:\" header %s: %.*s",
2485 errmess, tt - h->text, h->text, verb, len, s));
2488 break; /* Out of address loop */
2491 /* Advance to the next address */
2493 s = ss + (terminator? 1:0);
2494 while (isspace(*s)) s++;
2495 } /* Next address */
2497 parse_allow_group = FALSE;
2498 parse_found_group = FALSE;
2499 } /* Next header unless yield has been set FALSE */
2505 /*************************************************
2506 * Check header names for 8-bit characters *
2507 *************************************************/
2509 /* This function checks for invalid charcters in header names. See
2510 RFC 5322, 2.2. and RFC 6532, 3.
2513 msgptr where to put an error message
2520 verify_check_header_names_ascii(uschar **msgptr)
2525 for (h = header_list; h != NULL; h = h->next)
2527 colon = Ustrchr(h->text, ':');
2528 for(s = h->text; s < colon; s++)
2530 if ((*s < 33) || (*s > 126))
2532 *msgptr = string_sprintf("Invalid character in header \"%.*s\" found",
2533 colon - h->text, h->text);
2541 /*************************************************
2542 * Check for blind recipients *
2543 *************************************************/
2545 /* This function checks that every (envelope) recipient is mentioned in either
2546 the To: or Cc: header lines, thus detecting blind carbon copies.
2548 There are two ways of scanning that could be used: either scan the header lines
2549 and tick off the recipients, or scan the recipients and check the header lines.
2550 The original proposed patch did the former, but I have chosen to do the latter,
2551 because (a) it requires no memory and (b) will use fewer resources when there
2552 are many addresses in To: and/or Cc: and only one or two envelope recipients.
2555 Returns: OK if there are no blind recipients
2556 FAIL if there is at least one blind recipient
2560 verify_check_notblind(void)
2563 for (i = 0; i < recipients_count; i++)
2567 uschar *address = recipients_list[i].address;
2569 for (h = header_list; !found && h != NULL; h = h->next)
2573 if (h->type != htype_to && h->type != htype_cc) continue;
2575 colon = Ustrchr(h->text, ':');
2577 while (isspace(*s)) s++;
2579 /* Loop for multiple addresses in the header, enabling group syntax. Note
2580 that we have to reset this after the header has been scanned. */
2582 parse_allow_group = TRUE;
2586 uschar *ss = parse_find_address_end(s, FALSE);
2587 uschar *recipient,*errmess;
2588 int terminator = *ss;
2589 int start, end, domain;
2591 /* Temporarily terminate the string at this point, and extract the
2592 operative address within, allowing group syntax. */
2595 recipient = parse_extract_address(s,&errmess,&start,&end,&domain,FALSE);
2598 /* If we found a valid recipient that has a domain, compare it with the
2599 envelope recipient. Local parts are compared case-sensitively, domains
2600 case-insensitively. By comparing from the start with length "domain", we
2601 include the "@" at the end, which ensures that we are comparing the whole
2602 local part of each address. */
2604 if (recipient != NULL && domain != 0)
2606 found = Ustrncmp(recipient, address, domain) == 0 &&
2607 strcmpic(recipient + domain, address + domain) == 0;
2611 /* Advance to the next address */
2613 s = ss + (terminator? 1:0);
2614 while (isspace(*s)) s++;
2615 } /* Next address */
2617 parse_allow_group = FALSE;
2618 parse_found_group = FALSE;
2619 } /* Next header (if found is false) */
2621 if (!found) return FAIL;
2622 } /* Next recipient */
2629 /*************************************************
2630 * Find if verified sender *
2631 *************************************************/
2633 /* Usually, just a single address is verified as the sender of the message.
2634 However, Exim can be made to verify other addresses as well (often related in
2635 some way), and this is useful in some environments. There may therefore be a
2636 chain of such addresses that have previously been tested. This function finds
2637 whether a given address is on the chain.
2639 Arguments: the address to be verified
2640 Returns: pointer to an address item, or NULL
2644 verify_checked_sender(uschar *sender)
2647 for (addr = sender_verified_list; addr != NULL; addr = addr->next)
2648 if (Ustrcmp(sender, addr->address) == 0) break;
2656 /*************************************************
2657 * Get valid header address *
2658 *************************************************/
2660 /* Scan the originator headers of the message, looking for an address that
2661 verifies successfully. RFC 822 says:
2663 o The "Sender" field mailbox should be sent notices of
2664 any problems in transport or delivery of the original
2665 messages. If there is no "Sender" field, then the
2666 "From" field mailbox should be used.
2668 o If the "Reply-To" field exists, then the reply should
2669 go to the addresses indicated in that field and not to
2670 the address(es) indicated in the "From" field.
2672 So we check a Sender field if there is one, else a Reply_to field, else a From
2673 field. As some strange messages may have more than one of these fields,
2674 especially if they are resent- fields, check all of them if there is more than
2678 user_msgptr points to where to put a user error message
2679 log_msgptr points to where to put a log error message
2680 callout timeout for callout check (passed to verify_address())
2681 callout_overall overall callout timeout (ditto)
2682 callout_connect connect callout timeout (ditto)
2683 se_mailfrom mailfrom for verify; NULL => ""
2684 pm_mailfrom sender for pm callout check (passed to verify_address())
2685 options callout options (passed to verify_address())
2686 verrno where to put the address basic_errno
2688 If log_msgptr is set to something without setting user_msgptr, the caller
2689 normally uses log_msgptr for both things.
2691 Returns: result of the verification attempt: OK, FAIL, or DEFER;
2692 FAIL is given if no appropriate headers are found
2696 verify_check_header_address(uschar **user_msgptr, uschar **log_msgptr,
2697 int callout, int callout_overall, int callout_connect, uschar *se_mailfrom,
2698 uschar *pm_mailfrom, int options, int *verrno)
2700 static int header_types[] = { htype_sender, htype_reply_to, htype_from };
2705 for (i = 0; i < 3 && !done; i++)
2708 for (h = header_list; h != NULL && !done; h = h->next)
2710 int terminator, new_ok;
2711 uschar *s, *ss, *endname;
2713 if (h->type != header_types[i]) continue;
2714 s = endname = Ustrchr(h->text, ':') + 1;
2716 /* Scan the addresses in the header, enabling group syntax. Note that we
2717 have to reset this after the header has been scanned. */
2719 parse_allow_group = TRUE;
2723 address_item *vaddr;
2725 while (isspace(*s) || *s == ',') s++;
2726 if (*s == 0) break; /* End of header */
2728 ss = parse_find_address_end(s, FALSE);
2730 /* The terminator is a comma or end of header, but there may be white
2731 space preceding it (including newline for the last address). Move back
2732 past any white space so we can check against any cached envelope sender
2733 address verifications. */
2735 while (isspace(ss[-1])) ss--;
2739 HDEBUG(D_verify) debug_printf("verifying %.*s header address %s\n",
2740 (int)(endname - h->text), h->text, s);
2742 /* See if we have already verified this address as an envelope sender,
2743 and if so, use the previous answer. */
2745 vaddr = verify_checked_sender(s);
2747 if (vaddr != NULL && /* Previously checked */
2748 (callout <= 0 || /* No callout needed; OR */
2749 vaddr->special_action > 256)) /* Callout was done */
2751 new_ok = vaddr->special_action & 255;
2752 HDEBUG(D_verify) debug_printf("previously checked as envelope sender\n");
2753 *ss = terminator; /* Restore shortened string */
2756 /* Otherwise we run the verification now. We must restore the shortened
2757 string before running the verification, so the headers are correct, in
2758 case there is any rewriting. */
2762 int start, end, domain;
2763 uschar *address = parse_extract_address(s, log_msgptr, &start, &end,
2768 /* If we found an empty address, just carry on with the next one, but
2769 kill the message. */
2771 if (address == NULL && Ustrcmp(*log_msgptr, "empty address") == 0)
2778 /* If verification failed because of a syntax error, fail this
2779 function, and ensure that the failing address gets added to the error
2782 if (address == NULL)
2785 while (ss > s && isspace(ss[-1])) ss--;
2786 *log_msgptr = string_sprintf("syntax error in '%.*s' header when "
2787 "scanning for sender: %s in \"%.*s\"",
2788 endname - h->text, h->text, *log_msgptr, ss - s, s);
2794 /* Else go ahead with the sender verification. But it isn't *the*
2795 sender of the message, so set vopt_fake_sender to stop sender_address
2796 being replaced after rewriting or qualification. */
2800 vaddr = deliver_make_addr(address, FALSE);
2801 new_ok = verify_address(vaddr, NULL, options | vopt_fake_sender,
2802 callout, callout_overall, callout_connect, se_mailfrom,
2807 /* We now have the result, either newly found, or cached. If we are
2808 giving out error details, set a specific user error. This means that the
2809 last of these will be returned to the user if all three fail. We do not
2810 set a log message - the generic one below will be used. */
2814 *verrno = vaddr->basic_errno;
2815 if (smtp_return_error_details)
2817 *user_msgptr = string_sprintf("Rejected after DATA: "
2818 "could not verify \"%.*s\" header address\n%s: %s",
2819 endname - h->text, h->text, vaddr->address, vaddr->message);
2823 /* Success or defer */
2832 if (new_ok == DEFER) yield = DEFER;
2834 /* Move on to any more addresses in the header */
2837 } /* Next address */
2839 parse_allow_group = FALSE;
2840 parse_found_group = FALSE;
2841 } /* Next header, unless done */
2842 } /* Next header type unless done */
2844 if (yield == FAIL && *log_msgptr == NULL)
2845 *log_msgptr = US"there is no valid sender in any header line";
2847 if (yield == DEFER && *log_msgptr == NULL)
2848 *log_msgptr = US"all attempts to verify a sender in a header line deferred";
2856 /*************************************************
2857 * Get RFC 1413 identification *
2858 *************************************************/
2860 /* Attempt to get an id from the sending machine via the RFC 1413 protocol. If
2861 the timeout is set to zero, then the query is not done. There may also be lists
2862 of hosts and nets which are exempt. To guard against malefactors sending
2863 non-printing characters which could, for example, disrupt a message's headers,
2864 make sure the string consists of printing characters only.
2867 port the port to connect to; usually this is IDENT_PORT (113), but when
2868 running in the test harness with -bh a different value is used.
2872 Side effect: any received ident value is put in sender_ident (NULL otherwise)
2876 verify_get_ident(int port)
2878 int sock, host_af, qlen;
2879 int received_sender_port, received_interface_port, n;
2881 uschar buffer[2048];
2883 /* Default is no ident. Check whether we want to do an ident check for this
2886 sender_ident = NULL;
2887 if (rfc1413_query_timeout <= 0 || verify_check_host(&rfc1413_hosts) != OK)
2890 DEBUG(D_ident) debug_printf("doing ident callback\n");
2892 /* Set up a connection to the ident port of the remote host. Bind the local end
2893 to the incoming interface address. If the sender host address is an IPv6
2894 address, the incoming interface address will also be IPv6. */
2896 host_af = (Ustrchr(sender_host_address, ':') == NULL)? AF_INET : AF_INET6;
2897 sock = ip_socket(SOCK_STREAM, host_af);
2898 if (sock < 0) return;
2900 if (ip_bind(sock, host_af, interface_address, 0) < 0)
2902 DEBUG(D_ident) debug_printf("bind socket for ident failed: %s\n",
2907 if (ip_connect(sock, host_af, sender_host_address, port, rfc1413_query_timeout)
2910 if (errno == ETIMEDOUT && LOGGING(ident_timeout))
2912 log_write(0, LOG_MAIN, "ident connection to %s timed out",
2913 sender_host_address);
2917 DEBUG(D_ident) debug_printf("ident connection to %s failed: %s\n",
2918 sender_host_address, strerror(errno));
2923 /* Construct and send the query. */
2925 sprintf(CS buffer, "%d , %d\r\n", sender_host_port, interface_port);
2926 qlen = Ustrlen(buffer);
2927 if (send(sock, buffer, qlen, 0) < 0)
2929 DEBUG(D_ident) debug_printf("ident send failed: %s\n", strerror(errno));
2933 /* Read a response line. We put it into the rest of the buffer, using several
2934 recv() calls if necessary. */
2942 int size = sizeof(buffer) - (p - buffer);
2944 if (size <= 0) goto END_OFF; /* Buffer filled without seeing \n. */
2945 count = ip_recv(sock, p, size, rfc1413_query_timeout);
2946 if (count <= 0) goto END_OFF; /* Read error or EOF */
2948 /* Scan what we just read, to see if we have reached the terminating \r\n. Be
2949 generous, and accept a plain \n terminator as well. The only illegal
2952 for (pp = p; pp < p + count; pp++)
2954 if (*pp == 0) goto END_OFF; /* Zero octet not allowed */
2957 if (pp[-1] == '\r') pp--;
2959 goto GOT_DATA; /* Break out of both loops */
2963 /* Reached the end of the data without finding \n. Let the loop continue to
2964 read some more, if there is room. */
2971 /* We have received a line of data. Check it carefully. It must start with the
2972 same two port numbers that we sent, followed by data as defined by the RFC. For
2975 12345 , 25 : USERID : UNIX :root
2977 However, the amount of white space may be different to what we sent. In the
2978 "osname" field there may be several sub-fields, comma separated. The data we
2979 actually want to save follows the third colon. Some systems put leading spaces
2980 in it - we discard those. */
2982 if (sscanf(CS buffer + qlen, "%d , %d%n", &received_sender_port,
2983 &received_interface_port, &n) != 2 ||
2984 received_sender_port != sender_host_port ||
2985 received_interface_port != interface_port)
2988 p = buffer + qlen + n;
2989 while(isspace(*p)) p++;
2990 if (*p++ != ':') goto END_OFF;
2991 while(isspace(*p)) p++;
2992 if (Ustrncmp(p, "USERID", 6) != 0) goto END_OFF;
2994 while(isspace(*p)) p++;
2995 if (*p++ != ':') goto END_OFF;
2996 while (*p != 0 && *p != ':') p++;
2997 if (*p++ == 0) goto END_OFF;
2998 while(isspace(*p)) p++;
2999 if (*p == 0) goto END_OFF;
3001 /* The rest of the line is the data we want. We turn it into printing
3002 characters when we save it, so that it cannot mess up the format of any logging
3003 or Received: lines into which it gets inserted. We keep a maximum of 127
3004 characters. The deconst cast is ok as we fed a nonconst to string_printing() */
3006 sender_ident = US string_printing(string_copyn(p, 127));
3007 DEBUG(D_ident) debug_printf("sender_ident = %s\n", sender_ident);
3017 /*************************************************
3018 * Match host to a single host-list item *
3019 *************************************************/
3021 /* This function compares a host (name or address) against a single item
3022 from a host list. The host name gets looked up if it is needed and is not
3023 already known. The function is called from verify_check_this_host() via
3024 match_check_list(), which is why most of its arguments are in a single block.
3027 arg the argument block (see below)
3028 ss the host-list item
3029 valueptr where to pass back looked up data, or NULL
3030 error for error message when returning ERROR
3033 host_name (a) the host name, or
3034 (b) NULL, implying use sender_host_name and
3035 sender_host_aliases, looking them up if required, or
3036 (c) the empty string, meaning that only IP address matches
3038 host_address the host address
3039 host_ipv4 the IPv4 address taken from an IPv6 one
3043 DEFER lookup deferred
3044 ERROR (a) failed to find the host name or IP address, or
3045 (b) unknown lookup type specified, or
3046 (c) host name encountered when only IP addresses are
3051 check_host(void *arg, const uschar *ss, const uschar **valueptr, uschar **error)
3053 check_host_block *cb = (check_host_block *)arg;
3056 BOOL iplookup = FALSE;
3057 BOOL isquery = FALSE;
3058 BOOL isiponly = cb->host_name != NULL && cb->host_name[0] == 0;
3063 /* Optimize for the special case when the pattern is "*". */
3065 if (*ss == '*' && ss[1] == 0) return OK;
3067 /* If the pattern is empty, it matches only in the case when there is no host -
3068 this can occur in ACL checking for SMTP input using the -bs option. In this
3069 situation, the host address is the empty string. */
3071 if (cb->host_address[0] == 0) return (*ss == 0)? OK : FAIL;
3072 if (*ss == 0) return FAIL;
3074 /* If the pattern is precisely "@" then match against the primary host name,
3075 provided that host name matching is permitted; if it's "@[]" match against the
3076 local host's IP addresses. */
3082 if (isiponly) return ERROR;
3083 ss = primary_hostname;
3085 else if (Ustrcmp(ss, "@[]") == 0)
3087 ip_address_item *ip;
3088 for (ip = host_find_interfaces(); ip != NULL; ip = ip->next)
3089 if (Ustrcmp(ip->address, cb->host_address) == 0) return OK;
3094 /* If the pattern is an IP address, optionally followed by a bitmask count, do
3095 a (possibly masked) comparision with the current IP address. */
3097 if (string_is_ip_address(ss, &maskoffset) != 0)
3098 return (host_is_in_net(cb->host_address, ss, maskoffset)? OK : FAIL);
3100 /* The pattern is not an IP address. A common error that people make is to omit
3101 one component of an IPv4 address, either by accident, or believing that, for
3102 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,
3103 which it isn't. (Those applications that do accept 1.2.3 as an IP address
3104 interpret it as 1.2.0.3 because the final component becomes 16-bit - this is an
3105 ancient specification.) To aid in debugging these cases, we give a specific
3106 error if the pattern contains only digits and dots or contains a slash preceded
3107 only by digits and dots (a slash at the start indicates a file name and of
3108 course slashes may be present in lookups, but not preceded only by digits and
3111 for (t = ss; isdigit(*t) || *t == '.'; t++);
3112 if (*t == 0 || (*t == '/' && t != ss))
3114 *error = US"malformed IPv4 address or address mask";
3118 /* See if there is a semicolon in the pattern */
3120 semicolon = Ustrchr(ss, ';');
3122 /* If we are doing an IP address only match, then all lookups must be IP
3123 address lookups, even if there is no "net-". */
3127 iplookup = semicolon != NULL;
3130 /* Otherwise, if the item is of the form net[n]-lookup;<file|query> then it is
3131 a lookup on a masked IP network, in textual form. We obey this code even if we
3132 have already set iplookup, so as to skip over the "net-" prefix and to set the
3133 mask length. The net- stuff really only applies to single-key lookups where the
3134 key is implicit. For query-style lookups the key is specified in the query.
3135 From release 4.30, the use of net- for query style is no longer needed, but we
3136 retain it for backward compatibility. */
3138 if (Ustrncmp(ss, "net", 3) == 0 && semicolon != NULL)
3141 for (t = ss + 3; isdigit(*t); t++) mlen = mlen * 10 + *t - '0';
3142 if (mlen == 0 && t == ss+3) mlen = -1; /* No mask supplied */
3143 iplookup = (*t++ == '-');
3147 /* Do the IP address lookup if that is indeed what we have */
3155 uschar *filename, *key, *result;
3158 /* Find the search type */
3160 search_type = search_findtype(t, semicolon - t);
3162 if (search_type < 0) log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s",
3163 search_error_message);
3165 /* Adjust parameters for the type of lookup. For a query-style lookup, there
3166 is no file name, and the "key" is just the query. For query-style with a file
3167 name, we have to fish the file off the start of the query. For a single-key
3168 lookup, the key is the current IP address, masked appropriately, and
3169 reconverted to text form, with the mask appended. For IPv6 addresses, specify
3170 dot separators instead of colons, except when the lookup type is "iplsearch".
3173 if (mac_islookup(search_type, lookup_absfilequery))
3175 filename = semicolon + 1;
3177 while (*key != 0 && !isspace(*key)) key++;
3178 filename = string_copyn(filename, key - filename);
3179 while (isspace(*key)) key++;
3181 else if (mac_islookup(search_type, lookup_querystyle))
3184 key = semicolon + 1;
3186 else /* Single-key style */
3188 int sep = (Ustrcmp(lookup_list[search_type]->name, "iplsearch") == 0)?
3190 insize = host_aton(cb->host_address, incoming);
3191 host_mask(insize, incoming, mlen);
3192 (void)host_nmtoa(insize, incoming, mlen, buffer, sep);
3194 filename = semicolon + 1;
3197 /* Now do the actual lookup; note that there is no search_close() because
3198 of the caching arrangements. */
3200 if (!(handle = search_open(filename, search_type, 0, NULL, NULL)))
3201 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", search_error_message);
3203 result = search_find(handle, filename, key, -1, NULL, 0, 0, NULL);
3204 if (valueptr != NULL) *valueptr = result;
3205 return (result != NULL)? OK : search_find_defer? DEFER: FAIL;
3208 /* The pattern is not an IP address or network reference of any kind. That is,
3209 it is a host name pattern. If this is an IP only match, there's an error in the
3214 *error = US"cannot match host name in match_ip list";
3218 /* Check the characters of the pattern to see if they comprise only letters,
3219 digits, full stops, and hyphens (the constituents of domain names). Allow
3220 underscores, as they are all too commonly found. Sigh. Also, if
3221 allow_utf8_domains is set, allow top-bit characters. */
3223 for (t = ss; *t != 0; t++)
3224 if (!isalnum(*t) && *t != '.' && *t != '-' && *t != '_' &&
3225 (!allow_utf8_domains || *t < 128)) break;
3227 /* If the pattern is a complete domain name, with no fancy characters, look up
3228 its IP address and match against that. Note that a multi-homed host will add
3229 items to the chain. */
3240 /* Using byname rather than bydns here means we cannot determine dnssec
3241 status. On the other hand it is unclear how that could be either
3242 propagated up or enforced. */
3244 rc = host_find_byname(&h, NULL, HOST_FIND_QUALIFY_SINGLE, NULL, FALSE);
3245 if (rc == HOST_FOUND || rc == HOST_FOUND_LOCAL)
3248 for (hh = &h; hh != NULL; hh = hh->next)
3250 if (host_is_in_net(hh->address, cb->host_address, 0)) return OK;
3254 if (rc == HOST_FIND_AGAIN) return DEFER;
3255 *error = string_sprintf("failed to find IP address for %s", ss);
3259 /* Almost all subsequent comparisons require the host name, and can be done
3260 using the general string matching function. When this function is called for
3261 outgoing hosts, the name is always given explicitly. If it is NULL, it means we
3262 must use sender_host_name and its aliases, looking them up if necessary. */
3264 if (cb->host_name != NULL) /* Explicit host name given */
3265 return match_check_string(cb->host_name, ss, -1, TRUE, TRUE, TRUE,
3268 /* Host name not given; in principle we need the sender host name and its
3269 aliases. However, for query-style lookups, we do not need the name if the
3270 query does not contain $sender_host_name. From release 4.23, a reference to
3271 $sender_host_name causes it to be looked up, so we don't need to do the lookup
3274 if ((semicolon = Ustrchr(ss, ';')) != NULL)
3276 const uschar *affix;
3277 int partial, affixlen, starflags, id;
3280 id = search_findtype_partial(ss, &partial, &affix, &affixlen, &starflags);
3283 if (id < 0) /* Unknown lookup type */
3285 log_write(0, LOG_MAIN|LOG_PANIC, "%s in host list item \"%s\"",
3286 search_error_message, ss);
3289 isquery = mac_islookup(id, lookup_querystyle|lookup_absfilequery);
3294 switch(match_check_string(US"", ss, -1, TRUE, TRUE, TRUE, valueptr))
3297 case DEFER: return DEFER;
3298 default: return FAIL;
3302 /* Not a query-style lookup; must ensure the host name is present, and then we
3303 do a check on the name and all its aliases. */
3305 if (sender_host_name == NULL)
3307 HDEBUG(D_host_lookup)
3308 debug_printf("sender host name required, to match against %s\n", ss);
3309 if (host_lookup_failed || host_name_lookup() != OK)
3311 *error = string_sprintf("failed to find host name for %s",
3312 sender_host_address);;
3315 host_build_sender_fullhost();
3318 /* Match on the sender host name, using the general matching function */
3320 switch(match_check_string(sender_host_name, ss, -1, TRUE, TRUE, TRUE,
3324 case DEFER: return DEFER;
3327 /* If there are aliases, try matching on them. */
3329 aliases = sender_host_aliases;
3330 while (*aliases != NULL)
3332 switch(match_check_string(*aliases++, ss, -1, TRUE, TRUE, TRUE, valueptr))
3335 case DEFER: return DEFER;
3344 /*************************************************
3345 * Check a specific host matches a host list *
3346 *************************************************/
3348 /* This function is passed a host list containing items in a number of
3349 different formats and the identity of a host. Its job is to determine whether
3350 the given host is in the set of hosts defined by the list. The host name is
3351 passed as a pointer so that it can be looked up if needed and not already
3352 known. This is commonly the case when called from verify_check_host() to check
3353 an incoming connection. When called from elsewhere the host name should usually
3356 This function is now just a front end to match_check_list(), which runs common
3357 code for scanning a list. We pass it the check_host() function to perform a
3361 listptr pointer to the host list
3362 cache_bits pointer to cache for named lists, or NULL
3363 host_name the host name or NULL, implying use sender_host_name and
3364 sender_host_aliases, looking them up if required
3365 host_address the IP address
3366 valueptr if not NULL, data from a lookup is passed back here
3368 Returns: OK if the host is in the defined set
3369 FAIL if the host is not in the defined set,
3370 DEFER if a data lookup deferred (not a host lookup)
3372 If the host name was needed in order to make a comparison, and could not be
3373 determined from the IP address, the result is FAIL unless the item
3374 "+allow_unknown" was met earlier in the list, in which case OK is returned. */
3377 verify_check_this_host(const uschar **listptr, unsigned int *cache_bits,
3378 const uschar *host_name, const uschar *host_address, const uschar **valueptr)
3381 unsigned int *local_cache_bits = cache_bits;
3382 const uschar *save_host_address = deliver_host_address;
3383 check_host_block cb;
3384 cb.host_name = host_name;
3385 cb.host_address = host_address;
3387 if (valueptr != NULL) *valueptr = NULL;
3389 /* If the host address starts off ::ffff: it is an IPv6 address in
3390 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3393 cb.host_ipv4 = (Ustrncmp(host_address, "::ffff:", 7) == 0)?
3394 host_address + 7 : host_address;
3396 /* During the running of the check, put the IP address into $host_address. In
3397 the case of calls from the smtp transport, it will already be there. However,
3398 in other calls (e.g. when testing ignore_target_hosts), it won't. Just to be on
3399 the safe side, any existing setting is preserved, though as I write this
3400 (November 2004) I can't see any cases where it is actually needed. */
3402 deliver_host_address = host_address;
3403 rc = match_check_list(
3404 listptr, /* the list */
3405 0, /* separator character */
3406 &hostlist_anchor, /* anchor pointer */
3407 &local_cache_bits, /* cache pointer */
3408 check_host, /* function for testing */
3409 &cb, /* argument for function */
3410 MCL_HOST, /* type of check */
3411 (host_address == sender_host_address)?
3412 US"host" : host_address, /* text for debugging */
3413 valueptr); /* where to pass back data */
3414 deliver_host_address = save_host_address;
3421 /*************************************************
3422 * Check the given host item matches a list *
3423 *************************************************/
3425 verify_check_given_host(uschar **listptr, host_item *host)
3427 return verify_check_this_host(CUSS listptr, NULL, host->name, host->address, NULL);
3430 /*************************************************
3431 * Check the remote host matches a list *
3432 *************************************************/
3434 /* This is a front end to verify_check_this_host(), created because checking
3435 the remote host is a common occurrence. With luck, a good compiler will spot
3436 the tail recursion and optimize it. If there's no host address, this is
3437 command-line SMTP input - check against an empty string for the address.
3440 listptr pointer to the host list
3442 Returns: the yield of verify_check_this_host(),
3443 i.e. OK, FAIL, or DEFER
3447 verify_check_host(uschar **listptr)
3449 return verify_check_this_host(CUSS listptr, sender_host_cache, NULL,
3450 (sender_host_address == NULL)? US"" : sender_host_address, NULL);
3457 /*************************************************
3458 * Invert an IP address *
3459 *************************************************/
3461 /* Originally just used for DNS xBL lists, now also used for the
3462 reverse_ip expansion operator.
3465 buffer where to put the answer
3466 address the address to invert
3470 invert_address(uschar *buffer, uschar *address)
3473 uschar *bptr = buffer;
3475 /* If this is an IPv4 address mapped into IPv6 format, adjust the pointer
3476 to the IPv4 part only. */
3478 if (Ustrncmp(address, "::ffff:", 7) == 0) address += 7;
3480 /* Handle IPv4 address: when HAVE_IPV6 is false, the result of host_aton() is
3483 if (host_aton(address, bin) == 1)
3487 for (i = 0; i < 4; i++)
3489 sprintf(CS bptr, "%d.", x & 255);
3490 while (*bptr) bptr++;
3495 /* Handle IPv6 address. Actually, as far as I know, there are no IPv6 addresses
3496 in any DNS black lists, and the format in which they will be looked up is
3497 unknown. This is just a guess. */
3503 for (j = 3; j >= 0; j--)
3506 for (i = 0; i < 8; i++)
3508 sprintf(CS bptr, "%x.", x & 15);
3509 while (*bptr) bptr++;
3516 /* Remove trailing period -- this is needed so that both arbitrary
3517 dnsbl keydomains and inverted addresses may be combined with the
3518 same format string, "%s.%s" */
3525 /*************************************************
3526 * Perform a single dnsbl lookup *
3527 *************************************************/
3529 /* This function is called from verify_check_dnsbl() below. It is also called
3530 recursively from within itself when domain and domain_txt are different
3531 pointers, in order to get the TXT record from the alternate domain.
3534 domain the outer dnsbl domain
3535 domain_txt alternate domain to lookup TXT record on success; when the
3536 same domain is to be used, domain_txt == domain (that is,
3537 the pointers must be identical, not just the text)
3538 keydomain the current keydomain (for debug message)
3539 prepend subdomain to lookup (like keydomain, but
3540 reversed if IP address)
3541 iplist the list of matching IP addresses, or NULL for "any"
3542 bitmask true if bitmask matching is wanted
3543 match_type condition for 'succeed' result
3544 0 => Any RR in iplist (=)
3545 1 => No RR in iplist (!=)
3546 2 => All RRs in iplist (==)
3547 3 => Some RRs not in iplist (!==)
3548 the two bits are defined as MT_NOT and MT_ALL
3549 defer_return what to return for a defer
3551 Returns: OK if lookup succeeded
3556 one_check_dnsbl(uschar *domain, uschar *domain_txt, uschar *keydomain,
3557 uschar *prepend, uschar *iplist, BOOL bitmask, int match_type,
3563 dnsbl_cache_block *cb;
3564 int old_pool = store_pool;
3565 uschar query[256]; /* DNS domain max length */
3567 /* Construct the specific query domainname */
3569 if (!string_format(query, sizeof(query), "%s.%s", prepend, domain))
3571 log_write(0, LOG_MAIN|LOG_PANIC, "dnslist query is too long "
3572 "(ignored): %s...", query);
3576 /* Look for this query in the cache. */
3578 if ( (t = tree_search(dnsbl_cache, query))
3579 && (cb = t->data.ptr)->expiry > time(NULL)
3582 /* Previous lookup was cached */
3585 HDEBUG(D_dnsbl) debug_printf("using result of previous DNS lookup\n");
3588 /* If not cached from a previous lookup, we must do a DNS lookup, and
3589 cache the result in permanent memory. */
3595 store_pool = POOL_PERM;
3599 HDEBUG(D_dnsbl) debug_printf("cached data found but past valid time; ");
3603 { /* Set up a tree entry to cache the lookup */
3604 t = store_get(sizeof(tree_node) + Ustrlen(query));
3605 Ustrcpy(t->name, query);
3606 t->data.ptr = cb = store_get(sizeof(dnsbl_cache_block));
3607 (void)tree_insertnode(&dnsbl_cache, t);
3610 /* Do the DNS loopup . */
3612 HDEBUG(D_dnsbl) debug_printf("new DNS lookup for %s\n", query);
3613 cb->rc = dns_basic_lookup(&dnsa, query, T_A);
3614 cb->text_set = FALSE;
3618 /* If the lookup succeeded, cache the RHS address. The code allows for
3619 more than one address - this was for complete generality and the possible
3620 use of A6 records. However, A6 records have been reduced to experimental
3621 status (August 2001) and may die out. So they may never get used at all,
3622 let alone in dnsbl records. However, leave the code here, just in case.
3624 Quite apart from one A6 RR generating multiple addresses, there are DNS
3625 lists that return more than one A record, so we must handle multiple
3626 addresses generated in that way as well.
3628 Mark the cache entry with the "now" plus the minimum of the address TTLs,
3629 or some suitably far-future time if none were found. */
3631 if (cb->rc == DNS_SUCCEED)
3634 dns_address **addrp = &(cb->rhs);
3635 for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
3637 rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
3639 if (rr->type == T_A)
3641 dns_address *da = dns_address_from_rr(&dnsa, rr);
3645 while (da->next != NULL) da = da->next;
3646 addrp = &(da->next);
3647 if (ttl > rr->ttl) ttl = rr->ttl;
3652 /* If we didn't find any A records, change the return code. This can
3653 happen when there is a CNAME record but there are no A records for what
3656 if (cb->rhs == NULL) cb->rc = DNS_NODATA;
3659 cb->expiry = time(NULL)+ttl;
3660 store_pool = old_pool;
3663 /* We now have the result of the DNS lookup, either newly done, or cached
3664 from a previous call. If the lookup succeeded, check against the address
3665 list if there is one. This may be a positive equality list (introduced by
3666 "="), a negative equality list (introduced by "!="), a positive bitmask
3667 list (introduced by "&"), or a negative bitmask list (introduced by "!&").*/
3669 if (cb->rc == DNS_SUCCEED)
3671 dns_address *da = NULL;
3672 uschar *addlist = cb->rhs->address;
3674 /* For A and AAAA records, there may be multiple addresses from multiple
3675 records. For A6 records (currently not expected to be used) there may be
3676 multiple addresses from a single record. */
3678 for (da = cb->rhs->next; da != NULL; da = da->next)
3679 addlist = string_sprintf("%s, %s", addlist, da->address);
3681 HDEBUG(D_dnsbl) debug_printf("DNS lookup for %s succeeded (yielding %s)\n",
3684 /* Address list check; this can be either for equality, or via a bitmask.
3685 In the latter case, all the bits must match. */
3689 for (da = cb->rhs; da != NULL; da = da->next)
3693 const uschar *ptr = iplist;
3696 /* Handle exact matching */
3700 while ((res = string_nextinlist(&ptr, &ipsep, ip, sizeof(ip))) != NULL)
3702 if (Ustrcmp(CS da->address, ip) == 0) break;
3706 /* Handle bitmask matching */
3713 /* At present, all known DNS blocking lists use A records, with
3714 IPv4 addresses on the RHS encoding the information they return. I
3715 wonder if this will linger on as the last vestige of IPv4 when IPv6
3716 is ubiquitous? Anyway, for now we use paranoia code to completely
3717 ignore IPv6 addresses. The default mask is 0, which always matches.
3718 We change this only for IPv4 addresses in the list. */
3720 if (host_aton(da->address, address) == 1) mask = address[0];
3722 /* Scan the returned addresses, skipping any that are IPv6 */
3724 while ((res = string_nextinlist(&ptr, &ipsep, ip, sizeof(ip))) != NULL)
3726 if (host_aton(ip, address) != 1) continue;
3727 if ((address[0] & mask) == address[0]) break;
3733 (a) An IP address in an any ('=') list matched, or
3734 (b) No IP address in an all ('==') list matched
3736 then we're done searching. */
3738 if (((match_type & MT_ALL) != 0) == (res == NULL)) break;
3741 /* If da == NULL, either
3743 (a) No IP address in an any ('=') list matched, or
3744 (b) An IP address in an all ('==') list didn't match
3746 so behave as if the DNSBL lookup had not succeeded, i.e. the host is not on
3749 if ((match_type == MT_NOT || match_type == MT_ALL) != (da == NULL))
3757 res = US"was no match";
3760 res = US"was an exclude match";
3763 res = US"was an IP address that did not match";
3766 res = US"were no IP addresses that did not match";
3769 debug_printf("=> but we are not accepting this block class because\n");
3770 debug_printf("=> there %s for %s%c%s\n",
3772 ((match_type & MT_ALL) == 0)? "" : "=",
3773 bitmask? '&' : '=', iplist);
3779 /* Either there was no IP list, or the record matched, implying that the
3780 domain is on the list. We now want to find a corresponding TXT record. If an
3781 alternate domain is specified for the TXT record, call this function
3782 recursively to look that up; this has the side effect of re-checking that
3783 there is indeed an A record at the alternate domain. */
3785 if (domain_txt != domain)
3786 return one_check_dnsbl(domain_txt, domain_txt, keydomain, prepend, NULL,
3787 FALSE, match_type, defer_return);
3789 /* If there is no alternate domain, look up a TXT record in the main domain
3790 if it has not previously been cached. */
3794 cb->text_set = TRUE;
3795 if (dns_basic_lookup(&dnsa, query, T_TXT) == DNS_SUCCEED)
3798 for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
3800 rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
3801 if (rr->type == T_TXT) break;
3804 int len = (rr->data)[0];
3805 if (len > 511) len = 127;
3806 store_pool = POOL_PERM;
3807 cb->text = string_sprintf("%.*s", len, (const uschar *)(rr->data+1));
3808 store_pool = old_pool;
3813 dnslist_value = addlist;
3814 dnslist_text = cb->text;
3818 /* There was a problem with the DNS lookup */
3820 if (cb->rc != DNS_NOMATCH && cb->rc != DNS_NODATA)
3822 log_write(L_dnslist_defer, LOG_MAIN,
3823 "DNS list lookup defer (probably timeout) for %s: %s", query,
3824 (defer_return == OK)? US"assumed in list" :
3825 (defer_return == FAIL)? US"assumed not in list" :
3826 US"returned DEFER");
3827 return defer_return;
3830 /* No entry was found in the DNS; continue for next domain */
3834 debug_printf("DNS lookup for %s failed\n", query);
3835 debug_printf("=> that means %s is not listed at %s\n",
3845 /*************************************************
3846 * Check host against DNS black lists *
3847 *************************************************/
3849 /* This function runs checks against a list of DNS black lists, until one
3850 matches. Each item on the list can be of the form
3852 domain=ip-address/key
3854 The domain is the right-most domain that is used for the query, for example,
3855 blackholes.mail-abuse.org. If the IP address is present, there is a match only
3856 if the DNS lookup returns a matching IP address. Several addresses may be
3857 given, comma-separated, for example: x.y.z=127.0.0.1,127.0.0.2.
3859 If no key is given, what is looked up in the domain is the inverted IP address
3860 of the current client host. If a key is given, it is used to construct the
3861 domain for the lookup. For example:
3863 dsn.rfc-ignorant.org/$sender_address_domain
3865 After finding a match in the DNS, the domain is placed in $dnslist_domain, and
3866 then we check for a TXT record for an error message, and if found, save its
3867 value in $dnslist_text. We also cache everything in a tree, to optimize
3870 The TXT record is normally looked up in the same domain as the A record, but
3871 when many lists are combined in a single DNS domain, this will not be a very
3872 specific message. It is possible to specify a different domain for looking up
3873 TXT records; this is given before the main domain, comma-separated. For
3876 dnslists = http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
3877 socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3
3879 The caching ensures that only one lookup in dnsbl.sorbs.net is done.
3881 Note: an address for testing RBL is 192.203.178.39
3882 Note: an address for testing DUL is 192.203.178.4
3883 Note: a domain for testing RFCI is example.tld.dsn.rfc-ignorant.org
3887 listptr the domain/address/data list
3888 log_msgptr log message on error
3890 Returns: OK successful lookup (i.e. the address is on the list), or
3891 lookup deferred after +include_unknown
3892 FAIL name not found, or no data found for the given type, or
3893 lookup deferred after +exclude_unknown (default)
3894 DEFER lookup failure, if +defer_unknown was set
3898 verify_check_dnsbl(int where, const uschar ** listptr, uschar ** log_msgptr)
3901 int defer_return = FAIL;
3902 const uschar *list = *listptr;
3905 uschar buffer[1024];
3906 uschar revadd[128]; /* Long enough for IPv6 address */
3908 /* Indicate that the inverted IP address is not yet set up */
3912 /* In case this is the first time the DNS resolver is being used. */
3914 dns_init(FALSE, FALSE, FALSE); /*XXX dnssec? */
3916 /* Loop through all the domains supplied, until something matches */
3918 while ((domain = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
3921 BOOL bitmask = FALSE;
3928 HDEBUG(D_dnsbl) debug_printf("DNS list check: %s\n", domain);
3930 /* Deal with special values that change the behaviour on defer */
3932 if (domain[0] == '+')
3934 if (strcmpic(domain, US"+include_unknown") == 0) defer_return = OK;
3935 else if (strcmpic(domain, US"+exclude_unknown") == 0) defer_return = FAIL;
3936 else if (strcmpic(domain, US"+defer_unknown") == 0) defer_return = DEFER;
3938 log_write(0, LOG_MAIN|LOG_PANIC, "unknown item in dnslist (ignored): %s",
3943 /* See if there's explicit data to be looked up */
3945 if ((key = Ustrchr(domain, '/'))) *key++ = 0;
3947 /* See if there's a list of addresses supplied after the domain name. This is
3948 introduced by an = or a & character; if preceded by = we require all matches
3949 and if preceded by ! we invert the result. */
3951 if (!(iplist = Ustrchr(domain, '=')))
3954 iplist = Ustrchr(domain, '&');
3957 if (iplist) /* Found either = or & */
3959 if (iplist > domain && iplist[-1] == '!') /* Handle preceding ! */
3961 match_type |= MT_NOT;
3965 *iplist++ = 0; /* Terminate domain, move on */
3967 /* If we found = (bitmask == FALSE), check for == or =& */
3969 if (!bitmask && (*iplist == '=' || *iplist == '&'))
3971 bitmask = *iplist++ == '&';
3972 match_type |= MT_ALL;
3977 /* If there is a comma in the domain, it indicates that a second domain for
3978 looking up TXT records is provided, before the main domain. Otherwise we must
3979 set domain_txt == domain. */
3981 domain_txt = domain;
3982 comma = Ustrchr(domain, ',');
3989 /* Check that what we have left is a sensible domain name. There is no reason
3990 why these domains should in fact use the same syntax as hosts and email
3991 domains, but in practice they seem to. However, there is little point in
3992 actually causing an error here, because that would no doubt hold up incoming
3993 mail. Instead, I'll just log it. */
3995 for (s = domain; *s != 0; s++)
3997 if (!isalnum(*s) && *s != '-' && *s != '.' && *s != '_')
3999 log_write(0, LOG_MAIN, "dnslists domain \"%s\" contains "
4000 "strange characters - is this right?", domain);
4005 /* Check the alternate domain if present */
4007 if (domain_txt != domain) for (s = domain_txt; *s != 0; s++)
4009 if (!isalnum(*s) && *s != '-' && *s != '.' && *s != '_')
4011 log_write(0, LOG_MAIN, "dnslists domain \"%s\" contains "
4012 "strange characters - is this right?", domain_txt);
4017 /* If there is no key string, construct the query by adding the domain name
4018 onto the inverted host address, and perform a single DNS lookup. */
4022 if (where == ACL_WHERE_NOTSMTP_START || where == ACL_WHERE_NOTSMTP)
4024 *log_msgptr = string_sprintf
4025 ("cannot test auto-keyed dnslists condition in %s ACL",
4026 acl_wherenames[where]);
4029 if (sender_host_address == NULL) return FAIL; /* can never match */
4030 if (revadd[0] == 0) invert_address(revadd, sender_host_address);
4031 rc = one_check_dnsbl(domain, domain_txt, sender_host_address, revadd,
4032 iplist, bitmask, match_type, defer_return);
4035 dnslist_domain = string_copy(domain_txt);
4036 dnslist_matched = string_copy(sender_host_address);
4037 HDEBUG(D_dnsbl) debug_printf("=> that means %s is listed at %s\n",
4038 sender_host_address, dnslist_domain);
4040 if (rc != FAIL) return rc; /* OK or DEFER */
4043 /* If there is a key string, it can be a list of domains or IP addresses to
4044 be concatenated with the main domain. */
4051 uschar keybuffer[256];
4052 uschar keyrevadd[128];
4054 while ((keydomain = string_nextinlist(CUSS &key, &keysep, keybuffer,
4055 sizeof(keybuffer))) != NULL)
4057 uschar *prepend = keydomain;
4059 if (string_is_ip_address(keydomain, NULL) != 0)
4061 invert_address(keyrevadd, keydomain);
4062 prepend = keyrevadd;
4065 rc = one_check_dnsbl(domain, domain_txt, keydomain, prepend, iplist,
4066 bitmask, match_type, defer_return);
4070 dnslist_domain = string_copy(domain_txt);
4071 dnslist_matched = string_copy(keydomain);
4072 HDEBUG(D_dnsbl) debug_printf("=> that means %s is listed at %s\n",
4073 keydomain, dnslist_domain);
4077 /* If the lookup deferred, remember this fact. We keep trying the rest
4078 of the list to see if we get a useful result, and if we don't, we return
4079 DEFER at the end. */
4081 if (rc == DEFER) defer = TRUE;
4082 } /* continue with next keystring domain/address */
4084 if (defer) return DEFER;
4086 } /* continue with next dnsdb outer domain */
4093 /* End of verify.c */