1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
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_context ctctx;
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(client_conn_ctx *, char, uschar **, int);
46 /*************************************************
47 * Retrieve a callout cache record *
48 *************************************************/
50 /* If a record exists, check whether it has expired.
53 dbm_file an open hints file
55 type "address" or "domain"
56 positive_expire expire time for positive records
57 negative_expire expire time for negative records
59 Returns: the cache record if a non-expired one exists, else NULL
62 static dbdata_callout_cache *
63 get_callout_cache_record(open_db *dbm_file, const uschar *key, uschar *type,
64 int positive_expire, int negative_expire)
69 dbdata_callout_cache *cache_record;
71 if (!(cache_record = dbfn_read_with_length(dbm_file, key, &length)))
73 HDEBUG(D_verify) debug_printf("callout cache: no %s record found for %s\n", type, key);
77 /* We treat a record as "negative" if its result field is not positive, or if
78 it is a domain record and the postmaster field is negative. */
80 negative = cache_record->result != ccache_accept ||
81 (type[0] == 'd' && cache_record->postmaster_result == ccache_reject);
82 expire = negative? negative_expire : positive_expire;
85 if (now - cache_record->time_stamp > expire)
87 HDEBUG(D_verify) debug_printf("callout cache: %s record expired for %s\n", type, key);
91 /* If this is a non-reject domain record, check for the obsolete format version
92 that doesn't have the postmaster and random timestamps, by looking at the
93 length. If so, copy it to a new-style block, replicating the record's
94 timestamp. Then check the additional timestamps. (There's no point wasting
95 effort if connections are rejected.) */
97 if (type[0] == 'd' && cache_record->result != ccache_reject)
99 if (length == sizeof(dbdata_callout_cache_obs))
101 dbdata_callout_cache *new = store_get(sizeof(dbdata_callout_cache), FALSE);
102 memcpy(new, cache_record, length);
103 new->postmaster_stamp = new->random_stamp = new->time_stamp;
107 if (now - cache_record->postmaster_stamp > expire)
108 cache_record->postmaster_result = ccache_unknown;
110 if (now - cache_record->random_stamp > expire)
111 cache_record->random_result = ccache_unknown;
114 HDEBUG(D_verify) debug_printf("callout cache: found %s record for %s\n", type, key);
120 /* Check the callout cache.
121 Options * pm_mailfrom may be modified by cache partial results.
123 Return: TRUE if result found
127 cached_callout_lookup(address_item * addr, uschar * address_key,
128 uschar * from_address, int * opt_ptr, uschar ** pm_ptr,
129 int * yield, uschar ** failure_ptr,
130 dbdata_callout_cache * new_domain_record, int * old_domain_res)
132 int options = *opt_ptr;
134 open_db *dbm_file = NULL;
136 /* Open the callout cache database, it it exists, for reading only at this
137 stage, unless caching has been disabled. */
139 if (options & vopt_callout_no_cache)
141 HDEBUG(D_verify) debug_printf("callout cache: disabled by no_cache\n");
143 else if (!(dbm_file = dbfn_open(US"callout", O_RDWR, &dbblock, FALSE, TRUE)))
145 HDEBUG(D_verify) debug_printf("callout cache: not available\n");
149 /* If a cache database is available see if we can avoid the need to do an
150 actual callout by making use of previously-obtained data. */
152 dbdata_callout_cache_address * cache_address_record;
153 dbdata_callout_cache * cache_record = get_callout_cache_record(dbm_file,
154 addr->domain, US"domain",
155 callout_cache_domain_positive_expire, callout_cache_domain_negative_expire);
157 /* If an unexpired cache record was found for this domain, see if the callout
158 process can be short-circuited. */
162 /* In most cases, if an early command (up to and including MAIL FROM:<>)
163 was rejected, there is no point carrying on. The callout fails. However, if
164 we are doing a recipient verification with use_sender or use_postmaster
165 set, a previous failure of MAIL FROM:<> doesn't count, because this time we
166 will be using a non-empty sender. We have to remember this situation so as
167 not to disturb the cached domain value if this whole verification succeeds
168 (we don't want it turning into "accept"). */
170 *old_domain_res = cache_record->result;
172 if ( cache_record->result == ccache_reject
173 || *from_address == 0 && cache_record->result == ccache_reject_mfnull)
176 debug_printf("callout cache: domain gave initial rejection, or "
177 "does not accept HELO or MAIL FROM:<>\n");
178 setflag(addr, af_verify_nsfail);
179 addr->user_message = US"(result of an earlier callout reused).";
181 *failure_ptr = US"mail";
182 dbfn_close(dbm_file);
186 /* If a previous check on a "random" local part was accepted, we assume
187 that the server does not do any checking on local parts. There is therefore
188 no point in doing the callout, because it will always be successful. If a
189 random check previously failed, arrange not to do it again, but preserve
190 the data in the new record. If a random check is required but hasn't been
191 done, skip the remaining cache processing. */
193 if (options & vopt_callout_random) switch(cache_record->random_result)
197 debug_printf("callout cache: domain accepts random addresses\n");
198 *failure_ptr = US"random";
199 dbfn_close(dbm_file);
200 return TRUE; /* Default yield is OK */
204 debug_printf("callout cache: domain rejects random addresses\n");
205 *opt_ptr = options & ~vopt_callout_random;
206 new_domain_record->random_result = ccache_reject;
207 new_domain_record->random_stamp = cache_record->random_stamp;
212 debug_printf("callout cache: need to check random address handling "
213 "(not cached or cache expired)\n");
214 dbfn_close(dbm_file);
218 /* If a postmaster check is requested, but there was a previous failure,
219 there is again no point in carrying on. If a postmaster check is required,
220 but has not been done before, we are going to have to do a callout, so skip
221 remaining cache processing. */
225 if (cache_record->postmaster_result == ccache_reject)
227 setflag(addr, af_verify_pmfail);
229 debug_printf("callout cache: domain does not accept "
230 "RCPT TO:<postmaster@domain>\n");
232 *failure_ptr = US"postmaster";
233 setflag(addr, af_verify_pmfail);
234 addr->user_message = US"(result of earlier verification reused).";
235 dbfn_close(dbm_file);
238 if (cache_record->postmaster_result == ccache_unknown)
241 debug_printf("callout cache: need to check RCPT "
242 "TO:<postmaster@domain> (not cached or cache expired)\n");
243 dbfn_close(dbm_file);
247 /* If cache says OK, set pm_mailfrom NULL to prevent a redundant
248 postmaster check if the address itself has to be checked. Also ensure
249 that the value in the cache record is preserved (with its old timestamp).
252 HDEBUG(D_verify) debug_printf("callout cache: domain accepts RCPT "
253 "TO:<postmaster@domain>\n");
255 new_domain_record->postmaster_result = ccache_accept;
256 new_domain_record->postmaster_stamp = cache_record->postmaster_stamp;
260 /* We can't give a result based on information about the domain. See if there
261 is an unexpired cache record for this specific address (combined with the
262 sender address if we are doing a recipient callout with a non-empty sender).
265 if (!(cache_address_record = (dbdata_callout_cache_address *)
266 get_callout_cache_record(dbm_file, address_key, US"address",
267 callout_cache_positive_expire, callout_cache_negative_expire)))
269 dbfn_close(dbm_file);
273 if (cache_address_record->result == ccache_accept)
276 debug_printf("callout cache: address record is positive\n");
281 debug_printf("callout cache: address record is negative\n");
282 addr->user_message = US"Previous (cached) callout verification failure";
283 *failure_ptr = US"recipient";
287 /* Close the cache database while we actually do the callout for real. */
289 dbfn_close(dbm_file);
296 /* Write results to callout cache
299 cache_callout_write(dbdata_callout_cache * dom_rec, const uschar * domain,
300 int done, dbdata_callout_cache_address * addr_rec, uschar * address_key)
303 open_db *dbm_file = NULL;
305 /* If we get here with done == TRUE, a successful callout happened, and yield
306 will be set OK or FAIL according to the response to the RCPT command.
307 Otherwise, we looped through the hosts but couldn't complete the business.
308 However, there may be domain-specific information to cache in both cases.
310 The value of the result field in the new_domain record is ccache_unknown if
311 there was an error before or with MAIL FROM:, and errno was not zero,
312 implying some kind of I/O error. We don't want to write the cache in that case.
313 Otherwise the value is ccache_accept, ccache_reject, or ccache_reject_mfnull. */
315 if (dom_rec->result != ccache_unknown)
316 if (!(dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE, TRUE)))
318 HDEBUG(D_verify) debug_printf("callout cache: not available\n");
322 (void)dbfn_write(dbm_file, domain, dom_rec,
323 (int)sizeof(dbdata_callout_cache));
324 HDEBUG(D_verify) debug_printf("wrote callout cache domain record for %s:\n"
325 " result=%d postmaster=%d random=%d\n",
328 dom_rec->postmaster_result,
329 dom_rec->random_result);
332 /* If a definite result was obtained for the callout, cache it unless caching
335 if (done && addr_rec->result != ccache_unknown)
338 dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE, TRUE);
341 HDEBUG(D_verify) debug_printf("no callout cache available\n");
345 (void)dbfn_write(dbm_file, address_key, addr_rec,
346 (int)sizeof(dbdata_callout_cache_address));
347 HDEBUG(D_verify) debug_printf("wrote %s callout cache address record for %s\n",
348 addr_rec->result == ccache_accept ? "positive" : "negative",
353 if (dbm_file) dbfn_close(dbm_file);
357 /* Cutthrough-multi. If the existing cached cutthrough connection matches
358 the one we would make for a subsequent recipient, use it. Send the RCPT TO
359 and check the result, nonpipelined as it may be wanted immediately for
360 recipient-verification.
362 It seems simpler to deal with this case separately from the main callout loop.
363 We will need to remember it has sent, or not, so that rcpt-acl tail code
364 can do it there for the non-rcpt-verify case. For this we keep an addresscount.
366 Return: TRUE for a definitive result for the recipient
369 cutthrough_multi(address_item * addr, host_item * host_list,
370 transport_feedback * tf, int * yield)
374 if (addr->transport == cutthrough.addr.transport)
375 for (host_item * host = host_list; host; host = host->next)
376 if (Ustrcmp(host->address, cutthrough.host.address) == 0)
379 uschar *interface = NULL; /* Outgoing interface to use; NULL => any */
382 deliver_host = host->name;
383 deliver_host_address = host->address;
384 deliver_host_port = host->port;
385 deliver_domain = addr->domain;
386 transport_name = addr->transport->name;
388 host_af = Ustrchr(host->address, ':') ? AF_INET6 : AF_INET;
390 if ( !smtp_get_interface(tf->interface, host_af, addr, &interface,
392 || !smtp_get_port(tf->port, addr, &port, US"callout")
394 log_write(0, LOG_MAIN|LOG_PANIC, "<%s>: %s", addr->address,
397 smtp_port_for_connect(host, port);
399 if ( ( interface == cutthrough.interface
401 && cutthrough.interface
402 && Ustrcmp(interface, cutthrough.interface) == 0
404 && host->port == cutthrough.host.port
407 uschar * resp = NULL;
409 /* Match! Send the RCPT TO, set done from the response */
411 smtp_write_command(&ctctx, SCMD_FLUSH, "RCPT TO:<%.1000s>\r\n",
412 transport_rcpt_address(addr,
413 addr->transport->rcpt_include_affixes)) >= 0
414 && cutthrough_response(&cutthrough.cctx, '2', &resp,
415 CUTTHROUGH_DATA_TIMEOUT) == '2';
417 /* This would go horribly wrong if a callout fail was ignored by ACL.
418 We punt by abandoning cutthrough on a reject, like the
423 address_item * na = store_get(sizeof(address_item), FALSE);
424 *na = cutthrough.addr;
425 cutthrough.addr = *addr;
426 cutthrough.addr.host_used = &cutthrough.host;
427 cutthrough.addr.next = na;
433 cancel_cutthrough_connection(TRUE, US"recipient rejected");
434 if (!resp || errno == ETIMEDOUT)
436 HDEBUG(D_verify) debug_printf("SMTP timeout\n");
441 Ustrcpy(resp, US"connection dropped");
444 string_sprintf("response to \"%s\" was: %s",
445 big_buffer, string_printing(resp));
448 string_sprintf("Callout verification failed:\n%s", resp);
450 /* Hard rejection ends the process */
452 if (resp[0] == '5') /* Address rejected */
460 break; /* host_list */
463 cancel_cutthrough_connection(TRUE, US"incompatible connection");
468 /*************************************************
469 * Do callout verification for an address *
470 *************************************************/
472 /* This function is called from verify_address() when the address has routed to
473 a host list, and a callout has been requested. Callouts are expensive; that is
474 why a cache is used to improve the efficiency.
477 addr the address that's been routed
478 host_list the list of hosts to try
479 tf the transport feedback block
481 ifstring "interface" option from transport, or NULL
482 portstring "port" option from transport, or NULL
483 protocolstring "protocol" option from transport, or NULL
484 callout the per-command callout timeout
485 callout_overall the overall callout timeout (if < 0 use 4*callout)
486 callout_connect the callout connection timeout (if < 0 use callout)
487 options the verification options - these bits are used:
488 vopt_is_recipient => this is a recipient address
489 vopt_callout_no_cache => don't use callout cache
490 vopt_callout_fullpm => if postmaster check, do full one
491 vopt_callout_random => do the "random" thing
492 vopt_callout_recipsender => use real sender for recipient
493 vopt_callout_recippmaster => use postmaster for recipient
494 vopt_callout_hold => lazy close connection
495 se_mailfrom MAIL FROM address for sender verify; NULL => ""
496 pm_mailfrom if non-NULL, do the postmaster check with this sender
498 Returns: OK/FAIL/DEFER
502 do_callout(address_item *addr, host_item *host_list, transport_feedback *tf,
503 int callout, int callout_overall, int callout_connect, int options,
504 uschar *se_mailfrom, uschar *pm_mailfrom)
507 int old_domain_cache_result = ccache_accept;
510 uschar *from_address;
511 uschar *random_local_part = NULL;
512 const uschar *save_deliver_domain = deliver_domain;
513 uschar **failure_ptr = options & vopt_is_recipient
514 ? &recipient_verify_failure : &sender_verify_failure;
515 dbdata_callout_cache new_domain_record;
516 dbdata_callout_cache_address new_address_record;
517 time_t callout_start_time;
519 new_domain_record.result = ccache_unknown;
520 new_domain_record.postmaster_result = ccache_unknown;
521 new_domain_record.random_result = ccache_unknown;
523 memset(&new_address_record, 0, sizeof(new_address_record));
525 /* For a recipient callout, the key used for the address cache record must
526 include the sender address if we are using the real sender in the callout,
527 because that may influence the result of the callout. */
529 if (options & vopt_is_recipient)
530 if (options & vopt_callout_recipsender)
532 from_address = sender_address;
533 address_key = string_sprintf("%s/<%s>", addr->address, sender_address);
534 if (cutthrough.delivery) options |= vopt_callout_no_cache;
536 else if (options & vopt_callout_recippmaster)
538 from_address = string_sprintf("postmaster@%s", qualify_domain_sender);
539 address_key = string_sprintf("%s/<postmaster@%s>", addr->address,
540 qualify_domain_sender);
545 address_key = addr->address;
548 /* For a sender callout, we must adjust the key if the mailfrom address is not
553 from_address = se_mailfrom ? se_mailfrom : US"";
554 address_key = *from_address
555 ? string_sprintf("%s/<%s>", addr->address, from_address) : addr->address;
558 if (cached_callout_lookup(addr, address_key, from_address,
559 &options, &pm_mailfrom, &yield, failure_ptr,
560 &new_domain_record, &old_domain_cache_result))
562 cancel_cutthrough_connection(TRUE, US"cache-hit");
566 if (!addr->transport)
568 HDEBUG(D_verify) debug_printf("cannot callout via null transport\n");
570 else if (Ustrcmp(addr->transport->driver_name, "smtp") != 0)
571 log_write(0, LOG_MAIN|LOG_PANIC|LOG_CONFIG_FOR, "callout transport '%s': %s is non-smtp",
572 addr->transport->name, addr->transport->driver_name);
575 smtp_transport_options_block *ob =
576 (smtp_transport_options_block *)addr->transport->options_block;
578 /* The information wasn't available in the cache, so we have to do a real
579 callout and save the result in the cache for next time, unless no_cache is set,
580 or unless we have a previously cached negative random result. If we are to test
581 with a random local part, ensure that such a local part is available. If not,
582 log the fact, but carry on without randomising. */
584 if (options & vopt_callout_random && callout_random_local_part)
585 if (!(random_local_part = expand_string(callout_random_local_part)))
586 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand "
587 "callout_random_local_part: %s", expand_string_message);
589 /* Compile regex' used by client-side smtp */
593 /* Default the connect and overall callout timeouts if not set, and record the
594 time we are starting so that we can enforce it. */
596 if (callout_overall < 0) callout_overall = 4 * callout;
597 if (callout_connect < 0) callout_connect = callout;
598 callout_start_time = time(NULL);
600 /* Before doing a real callout, if this is an SMTP connection, flush the SMTP
601 output because a callout might take some time. When PIPELINING is active and
602 there are many recipients, the total time for doing lots of callouts can add up
603 and cause the client to time out. So in this case we forgo the PIPELINING
606 if (smtp_out && !f.disable_callout_flush) mac_smtp_fflush();
608 clearflag(addr, af_verify_pmfail); /* postmaster callout flag */
609 clearflag(addr, af_verify_nsfail); /* null sender callout flag */
611 /* cutthrough-multi: if a nonfirst rcpt has the same routing as the first,
612 and we are holding a cutthrough conn open, we can just append the rcpt to
613 that conn for verification purposes (and later delivery also). Simplest
614 coding means skipping this whole loop and doing the append separately. */
616 /* Can we re-use an open cutthrough connection? */
617 if ( cutthrough.cctx.sock >= 0
618 && (options & (vopt_callout_recipsender | vopt_callout_recippmaster))
619 == vopt_callout_recipsender
620 && !random_local_part
623 done = cutthrough_multi(addr, host_list, tf, &yield);
625 /* If we did not use a cached connection, make connections to the hosts
626 and do real callouts. The list of hosts is passed in as an argument. */
628 for (host_item * host = host_list; host && !done; host = host->next)
632 uschar *interface = NULL; /* Outgoing interface to use; NULL => any */
637 DEBUG(D_verify) debug_printf("no IP address for host name %s: skipping\n",
642 /* Check the overall callout timeout */
644 if (time(NULL) - callout_start_time >= callout_overall)
646 HDEBUG(D_verify) debug_printf("overall timeout for callout exceeded\n");
650 /* Set IPv4 or IPv6 */
652 host_af = Ustrchr(host->address, ':') ? AF_INET6 : AF_INET;
654 /* Expand and interpret the interface and port strings. The latter will not
655 be used if there is a host-specific port (e.g. from a manualroute router).
656 This has to be delayed till now, because they may expand differently for
657 different hosts. If there's a failure, log it, but carry on with the
660 deliver_host = host->name;
661 deliver_host_address = host->address;
662 deliver_host_port = host->port;
663 deliver_domain = addr->domain;
664 transport_name = addr->transport->name;
666 if ( !smtp_get_interface(tf->interface, host_af, addr, &interface,
668 || !smtp_get_port(tf->port, addr, &port, US"callout")
670 log_write(0, LOG_MAIN|LOG_PANIC, "<%s>: %s", addr->address,
674 sx.conn_args.host = host;
675 sx.conn_args.host_af = host_af,
677 sx.conn_args.interface = interface;
678 sx.helo_data = tf->helo_data;
679 sx.conn_args.tblock = addr->transport;
682 tls_retry_connection:
683 /* Set the address state so that errors are recorded in it */
685 addr->transport_return = PENDING_DEFER;
686 ob->connect_timeout = callout_connect;
687 ob->command_timeout = callout;
689 /* Get the channel set up ready for a message (MAIL FROM being the next
690 SMTP command to send. If we tried TLS but it failed, try again without
693 yield = smtp_setup_conn(&sx, FALSE);
696 && addr->basic_errno == ERRNO_TLSFAILURE
697 && ob->tls_tempfail_tryclear
698 && verify_check_given_host(CUSS &ob->hosts_require_tls, host) != OK
701 log_write(0, LOG_MAIN,
702 "%s: callout unencrypted to %s [%s] (not in hosts_require_tls)",
703 addr->message, host->name, host->address);
704 addr->transport_return = PENDING_DEFER;
705 yield = smtp_setup_conn(&sx, TRUE);
710 errno = addr->basic_errno;
711 transport_name = NULL;
712 deliver_host = deliver_host_address = NULL;
713 deliver_domain = save_deliver_domain;
715 /* Failure to accept HELO is cached; this blocks the whole domain for all
716 senders. I/O errors and defer responses are not cached. */
718 if (yield == FAIL && (errno == 0 || errno == ERRNO_SMTPCLOSED))
720 setflag(addr, af_verify_nsfail);
721 new_domain_record.result = ccache_reject;
729 /* If we needed to authenticate, smtp_setup_conn() did that. Copy
730 the AUTH info for logging */
732 addr->authenticator = client_authenticator;
733 addr->auth_id = client_authenticated_id;
735 sx.from_addr = from_address;
736 sx.first_addr = sx.sync_addr = addr;
737 sx.ok = FALSE; /*XXX these 3 last might not be needed for verify? */
739 sx.completed_addr = FALSE;
741 new_domain_record.result = old_domain_cache_result == ccache_reject_mfnull
742 ? ccache_reject_mfnull : ccache_accept;
744 /* Do the random local part check first. Temporarily replace the recipient
745 with the "random" value */
747 if (random_local_part)
749 uschar * main_address = addr->address;
750 const uschar * rcpt_domain = addr->domain;
753 uschar * errstr = NULL;
754 if ( testflag(addr, af_utf8_downcvt)
755 && (rcpt_domain = string_domain_utf8_to_alabel(rcpt_domain,
759 addr->message = errstr;
760 errno = ERRNO_EXPANDFAIL;
761 setflag(addr, af_verify_nsfail);
763 rcpt_domain = US""; /*XXX errorhandling! */
767 /* This would be ok for 1st rcpt of a cutthrough (the case handled here;
768 subsequents are done in cutthrough_multi()), but no way to
769 handle a subsequent because of the RSET vaporising the MAIL FROM.
770 So refuse to support any. Most cutthrough use will not involve
771 random_local_part, so no loss. */
772 cancel_cutthrough_connection(TRUE, US"random-recipient");
774 addr->address = string_sprintf("%s@%.1000s",
775 random_local_part, rcpt_domain);
778 /* If accepted, we aren't going to do any further tests below.
779 Otherwise, cache a real negative response, and get back to the right
780 state to send RCPT. Unless there's some problem such as a dropped
781 connection, we expect to succeed, because the commands succeeded above.
782 However, some servers drop the connection after responding to an
783 invalid recipient, so on (any) error we drop and remake the connection.
784 XXX We don't care about that for postmaster_full. Should we?
786 XXX could we add another flag to the context, and have the common
787 code emit the RSET too? Even pipelined after the RCPT...
788 Then the main-verify call could use it if there's to be a subsequent
790 The sync_responses() would need to be taught about it and we'd
791 need another return code filtering out to here.
793 Avoid using a SIZE option on the MAIL for all random-rcpt checks.
796 sx.avoid_option = OPTION_SIZE;
798 /* Remember when we last did a random test */
799 new_domain_record.random_stamp = time(NULL);
801 if (smtp_write_mail_and_rcpt_cmds(&sx, &yield) == 0)
802 switch(addr->transport_return)
804 case PENDING_OK: /* random was accepted, unfortunately */
805 new_domain_record.random_result = ccache_accept;
806 yield = OK; /* Only usable verify result we can return */
808 *failure_ptr = US"random";
810 case FAIL: /* rejected: the preferred result */
811 new_domain_record.random_result = ccache_reject;
814 /* Between each check, issue RSET, because some servers accept only
815 one recipient after MAIL FROM:<>.
816 XXX We don't care about that for postmaster_full. Should we? */
819 smtp_write_command(&sx, SCMD_FLUSH, "RSET\r\n") >= 0 &&
820 smtp_read_response(&sx, sx.buffer, sizeof(sx.buffer), '2', callout)))
824 debug_printf_indent("problem after random/rset/mfrom; reopen conn\n");
825 random_local_part = NULL;
827 tls_close(sx.cctx.tls_ctx, TLS_SHUTDOWN_NOWAIT);
829 HDEBUG(D_transport|D_acl|D_v) debug_printf_indent(" SMTP(close)>>\n");
830 (void)close(sx.cctx.sock);
832 #ifndef DISABLE_EVENT
833 (void) event_raise(addr->transport->event_action,
834 US"tcp:close", NULL);
836 addr->address = main_address;
837 addr->transport_return = PENDING_DEFER;
838 sx.first_addr = sx.sync_addr = addr;
841 sx.completed_addr = FALSE;
842 goto tls_retry_connection;
843 case DEFER: /* 4xx response to random */
844 break; /* Just to be clear. ccache_unknown, !done. */
847 /* Re-setup for main verify, or for the error message when failing */
848 addr->address = main_address;
849 addr->transport_return = PENDING_DEFER;
850 sx.first_addr = sx.sync_addr = addr;
853 sx.completed_addr = FALSE;
858 /* Main verify. For rcpt-verify use SIZE if we know it and we're not cacheing;
859 for sndr-verify never use it. */
863 if (!(options & vopt_is_recipient && options & vopt_callout_no_cache))
864 sx.avoid_option = OPTION_SIZE;
867 switch(smtp_write_mail_and_rcpt_cmds(&sx, &yield))
869 case 0: switch(addr->transport_return) /* ok so far */
871 case PENDING_OK: done = TRUE;
872 new_address_record.result = ccache_accept;
874 case FAIL: done = TRUE;
876 *failure_ptr = US"recipient";
877 new_address_record.result = ccache_reject;
883 case -1: /* MAIL response error */
884 *failure_ptr = US"mail";
885 if (errno == 0 && sx.buffer[0] == '5')
887 setflag(addr, af_verify_nsfail);
888 if (from_address[0] == 0)
889 new_domain_record.result = ccache_reject_mfnull;
892 /* non-MAIL read i/o error */
893 /* non-MAIL response timeout */
894 /* internal error; channel still usable */
895 default: break; /* transmit failed */
899 addr->auth_sndr = client_authenticated_sender;
901 deliver_host = deliver_host_address = NULL;
902 deliver_domain = save_deliver_domain;
904 /* Do postmaster check if requested; if a full check is required, we
905 check for RCPT TO:<postmaster> (no domain) in accordance with RFC 821. */
907 if (done && pm_mailfrom)
909 /* Could possibly shift before main verify, just above, and be ok
910 for cutthrough. But no way to handle a subsequent rcpt, so just
912 cancel_cutthrough_connection(TRUE, US"postmaster verify");
913 HDEBUG(D_acl|D_v) debug_printf_indent("Cutthrough cancelled by presence of postmaster verify\n");
915 done = smtp_write_command(&sx, SCMD_FLUSH, "RSET\r\n") >= 0
916 && smtp_read_response(&sx, sx.buffer, sizeof(sx.buffer), '2', callout);
920 uschar * main_address = addr->address;
922 /*XXX oops, affixes */
923 addr->address = string_sprintf("postmaster@%.1000s", addr->domain);
924 addr->transport_return = PENDING_DEFER;
926 sx.from_addr = pm_mailfrom;
927 sx.first_addr = sx.sync_addr = addr;
930 sx.completed_addr = FALSE;
931 sx.avoid_option = OPTION_SIZE;
933 if( smtp_write_mail_and_rcpt_cmds(&sx, &yield) == 0
934 && addr->transport_return == PENDING_OK
938 done = (options & vopt_callout_fullpm) != 0
939 && smtp_write_command(&sx, SCMD_FLUSH,
940 "RCPT TO:<postmaster>\r\n") >= 0
941 && smtp_read_response(&sx, sx.buffer,
942 sizeof(sx.buffer), '2', callout);
944 /* Sort out the cache record */
946 new_domain_record.postmaster_stamp = time(NULL);
949 new_domain_record.postmaster_result = ccache_accept;
950 else if (errno == 0 && sx.buffer[0] == '5')
952 *failure_ptr = US"postmaster";
953 setflag(addr, af_verify_pmfail);
954 new_domain_record.postmaster_result = ccache_reject;
957 addr->address = main_address;
960 /* For any failure of the main check, other than a negative response, we just
961 close the connection and carry on. We can identify a negative response by the
962 fact that errno is zero. For I/O errors it will be non-zero
964 Set up different error texts for logging and for sending back to the caller
965 as an SMTP response. Log in all cases, using a one-line format. For sender
966 callouts, give a full response to the caller, but for recipient callouts,
967 don't give the IP address because this may be an internal host whose identity
968 is not to be widely broadcast. */
974 HDEBUG(D_verify) debug_printf("SMTP timeout\n");
975 sx.send_quit = FALSE;
981 extern int acl_where; /* src/acl.c */
983 addr->message = US"response to \"EHLO\" did not include SMTPUTF8";
984 addr->user_message = acl_where == ACL_WHERE_RCPT
985 ? US"533 no support for internationalised mailbox name"
986 : US"550 mailbox unavailable";
993 sx.send_quit = FALSE;
997 if (*sx.buffer == 0) Ustrcpy(sx.buffer, US"connection dropped");
999 /*XXX test here is ugly; seem to have a split of responsibility for
1000 building this message. Need to rationalise. Where is it done
1001 before here, and when not?
1002 Not == 5xx resp to MAIL on main-verify
1004 if (!addr->message) addr->message =
1005 string_sprintf("response to \"%s\" was: %s",
1006 big_buffer, string_printing(sx.buffer));
1008 /* RFC 5321 section 4.2: the text portion of the response may have only
1009 HT, SP, Printable US-ASCII. Deal with awkward chars by cutting the
1010 received message off before passing it onward. Newlines are ok; they
1011 just become a multiline response (but wrapped in the error code we
1014 for (uschar * s = sx.buffer;
1015 *s && s < sx.buffer + sizeof(sx.buffer);
1019 if (c != '\t' && c != '\n' && (c < ' ' || c > '~'))
1021 if (s - sx.buffer < sizeof(sx.buffer) - 12)
1022 memcpy(s, "(truncated)", 12);
1028 addr->user_message = options & vopt_is_recipient
1029 ? string_sprintf("Callout verification failed:\n%s", sx.buffer)
1030 : string_sprintf("Called: %s\nSent: %s\nResponse: %s",
1031 host->address, big_buffer, sx.buffer);
1033 /* Hard rejection ends the process */
1035 if (sx.buffer[0] == '5') /* Address rejected */
1043 /* End the SMTP conversation and close the connection. */
1045 /* Cutthrough - on a successful connect and recipient-verify with
1046 use-sender and we are 1st rcpt and have no cutthrough conn so far
1047 here is where we want to leave the conn open. Ditto for a lazy-close
1050 if (cutthrough.delivery)
1052 if (addr->transport->filter_command)
1054 cutthrough.delivery= FALSE;
1055 HDEBUG(D_acl|D_v) debug_printf("Cutthrough cancelled by presence of transport filter\n");
1057 #ifndef DISABLE_DKIM
1058 if (ob->dkim.dkim_domain)
1060 cutthrough.delivery= FALSE;
1061 HDEBUG(D_acl|D_v) debug_printf("Cutthrough cancelled by presence of DKIM signing\n");
1064 #ifdef EXPERIMENTAL_ARC
1067 cutthrough.delivery= FALSE;
1068 HDEBUG(D_acl|D_v) debug_printf("Cutthrough cancelled by presence of ARC signing\n");
1073 if ( (cutthrough.delivery || options & vopt_callout_hold)
1077 && (options & (vopt_callout_recipsender|vopt_callout_recippmaster|vopt_success_on_redirect))
1078 == vopt_callout_recipsender
1079 && !random_local_part
1081 && cutthrough.cctx.sock < 0
1085 HDEBUG(D_acl|D_v) debug_printf_indent("holding verify callout open for %s\n",
1087 ? "cutthrough delivery" : "potential further verifies and delivery");
1089 cutthrough.callout_hold_only = !cutthrough.delivery;
1090 cutthrough.is_tls = tls_out.active.sock >= 0;
1091 /* We assume no buffer in use in the outblock */
1092 cutthrough.cctx = sx.cctx;
1093 cutthrough.nrcpt = 1;
1094 cutthrough.transport = addr->transport->name;
1095 cutthrough.interface = interface;
1096 cutthrough.snd_port = sending_port;
1097 cutthrough.peer_options = smtp_peer_options;
1098 cutthrough.host = *host;
1100 int oldpool = store_pool;
1101 store_pool = POOL_PERM;
1102 cutthrough.snd_ip = string_copy(sending_ip_address);
1103 cutthrough.host.name = string_copy(host->name);
1104 cutthrough.host.address = string_copy(host->address);
1105 store_pool = oldpool;
1108 /* Save the address_item and parent chain for later logging */
1109 cutthrough.addr = *addr;
1110 cutthrough.addr.next = NULL;
1111 cutthrough.addr.host_used = &cutthrough.host;
1112 for (address_item * caddr = &cutthrough.addr, * parent = addr->parent;
1114 caddr = caddr->parent, parent = parent->parent)
1115 *(caddr->parent = store_get(sizeof(address_item), FALSE)) = *parent;
1117 ctctx.outblock.buffer = ctbuffer;
1118 ctctx.outblock.buffersize = sizeof(ctbuffer);
1119 ctctx.outblock.ptr = ctbuffer;
1120 /* ctctx.outblock.cmd_count = 0; ctctx.outblock.authenticating = FALSE; */
1121 ctctx.outblock.cctx = &cutthrough.cctx;
1125 /* Ensure no cutthrough on multiple verifies that were incompatible */
1126 if (options & vopt_callout_recipsender)
1127 cancel_cutthrough_connection(TRUE, US"not usable for cutthrough");
1129 if (smtp_write_command(&sx, SCMD_FLUSH, "QUIT\r\n") != -1)
1130 /* Wait a short time for response, and discard it */
1131 smtp_read_response(&sx, sx.buffer, sizeof(sx.buffer), '2', 1);
1133 if (sx.cctx.sock >= 0)
1136 if (sx.cctx.tls_ctx)
1138 tls_close(sx.cctx.tls_ctx, TLS_SHUTDOWN_NOWAIT);
1139 sx.cctx.tls_ctx = NULL;
1142 HDEBUG(D_transport|D_acl|D_v) debug_printf_indent(" SMTP(close)>>\n");
1143 (void)close(sx.cctx.sock);
1145 #ifndef DISABLE_EVENT
1146 (void) event_raise(addr->transport->event_action, US"tcp:close", NULL);
1151 if (!done || yield != OK)
1152 addr->message = string_sprintf("%s [%s] : %s", host->name, host->address,
1154 } /* Loop through all hosts, while !done */
1157 /* If we get here with done == TRUE, a successful callout happened, and yield
1158 will be set OK or FAIL according to the response to the RCPT command.
1159 Otherwise, we looped through the hosts but couldn't complete the business.
1160 However, there may be domain-specific information to cache in both cases. */
1162 if (!(options & vopt_callout_no_cache))
1163 cache_callout_write(&new_domain_record, addr->domain,
1164 done, &new_address_record, address_key);
1166 /* Failure to connect to any host, or any response other than 2xx or 5xx is a
1167 temporary error. If there was only one host, and a response was received, leave
1168 it alone if supplying details. Otherwise, give a generic response. */
1172 uschar * dullmsg = string_sprintf("Could not complete %s verify callout",
1173 options & vopt_is_recipient ? "recipient" : "sender");
1176 addr->message = host_list->next || !addr->message
1177 ? dullmsg : string_sprintf("%s: %s", dullmsg, addr->message);
1179 addr->user_message = smtp_return_error_details
1180 ? string_sprintf("%s for <%s>.\n"
1181 "The mail server(s) for the domain may be temporarily unreachable, or\n"
1182 "they may be permanently unreachable from this server. In the latter case,\n%s",
1183 dullmsg, addr->address,
1184 options & vopt_is_recipient
1185 ? "the address will never be accepted."
1186 : "you need to change the address or create an MX record for its domain\n"
1187 "if it is supposed to be generally accessible from the Internet.\n"
1188 "Talk to your mail administrator for details.")
1191 /* Force a specific error code */
1193 addr->basic_errno = ERRNO_CALLOUTDEFER;
1196 /* Come here from within the cache-reading code on fast-track exit. */
1199 tls_modify_variables(&tls_in); /* return variables to inbound values */
1205 /* Called after recipient-acl to get a cutthrough connection open when
1206 one was requested and a recipient-verify wasn't subsequently done.
1209 open_cutthrough_connection(address_item * addr)
1214 /* Use a recipient-verify-callout to set up the cutthrough connection. */
1215 /* We must use a copy of the address for verification, because it might
1219 HDEBUG(D_acl) debug_printf_indent("----------- %s cutthrough setup ------------\n",
1220 rcpt_count > 1 ? "more" : "start");
1221 rc = verify_address(&addr2, NULL,
1222 vopt_is_recipient | vopt_callout_recipsender | vopt_callout_no_cache,
1223 CUTTHROUGH_CMD_TIMEOUT, -1, -1,
1225 addr->message = addr2.message;
1226 addr->user_message = addr2.user_message;
1227 HDEBUG(D_acl) debug_printf_indent("----------- end cutthrough setup ------------\n");
1233 /* Send given number of bytes from the buffer */
1235 cutthrough_send(int n)
1237 if(cutthrough.cctx.sock < 0)
1243 ? tls_write(cutthrough.cctx.tls_ctx, ctctx.outblock.buffer, n, FALSE)
1246 send(cutthrough.cctx.sock, ctctx.outblock.buffer, n, 0) > 0
1249 transport_count += n;
1250 ctctx.outblock.ptr= ctctx.outblock.buffer;
1254 HDEBUG(D_transport|D_acl) debug_printf_indent("cutthrough_send failed: %s\n", strerror(errno));
1261 _cutthrough_puts(uschar * cp, int n)
1265 if(ctctx.outblock.ptr >= ctctx.outblock.buffer+ctctx.outblock.buffersize)
1266 if(!cutthrough_send(ctctx.outblock.buffersize))
1269 *ctctx.outblock.ptr++ = *cp++;
1274 /* Buffered output of counted data block. Return boolean success */
1276 cutthrough_puts(uschar * cp, int n)
1278 if (cutthrough.cctx.sock < 0) return TRUE;
1279 if (_cutthrough_puts(cp, n)) return TRUE;
1280 cancel_cutthrough_connection(TRUE, US"transmit failed");
1285 cutthrough_data_puts(uschar * cp, int n)
1287 if (cutthrough.delivery) (void) cutthrough_puts(cp, n);
1293 _cutthrough_flush_send(void)
1295 int n = ctctx.outblock.ptr - ctctx.outblock.buffer;
1298 if(!cutthrough_send(n))
1304 /* Send out any bufferred output. Return boolean success. */
1306 cutthrough_flush_send(void)
1308 if (_cutthrough_flush_send()) return TRUE;
1309 cancel_cutthrough_connection(TRUE, US"transmit failed");
1315 cutthrough_put_nl(void)
1317 return cutthrough_puts(US"\r\n", 2);
1322 cutthrough_data_put_nl(void)
1324 cutthrough_data_puts(US"\r\n", 2);
1328 /* Get and check response from cutthrough target */
1330 cutthrough_response(client_conn_ctx * cctx, char expect, uschar ** copy, int timeout)
1332 smtp_context sx = {0};
1333 uschar inbuffer[4096];
1334 uschar responsebuffer[4096];
1336 sx.inblock.buffer = inbuffer;
1337 sx.inblock.buffersize = sizeof(inbuffer);
1338 sx.inblock.ptr = inbuffer;
1339 sx.inblock.ptrend = inbuffer;
1340 sx.inblock.cctx = cctx;
1341 if(!smtp_read_response(&sx, responsebuffer, sizeof(responsebuffer), expect, timeout))
1342 cancel_cutthrough_connection(TRUE, US"target timeout on read");
1347 *copy = cp = string_copy(responsebuffer);
1348 /* Trim the trailing end of line */
1349 cp += Ustrlen(responsebuffer);
1350 if(cp > *copy && cp[-1] == '\n') *--cp = '\0';
1351 if(cp > *copy && cp[-1] == '\r') *--cp = '\0';
1354 return responsebuffer[0];
1358 /* Negotiate dataphase with the cutthrough target, returning success boolean */
1360 cutthrough_predata(void)
1362 if(cutthrough.cctx.sock < 0 || cutthrough.callout_hold_only)
1365 HDEBUG(D_transport|D_acl|D_v) debug_printf_indent(" SMTP>> DATA\n");
1366 cutthrough_puts(US"DATA\r\n", 6);
1367 cutthrough_flush_send();
1369 /* Assume nothing buffered. If it was it gets ignored. */
1370 return cutthrough_response(&cutthrough.cctx, '3', NULL, CUTTHROUGH_DATA_TIMEOUT) == '3';
1374 /* tctx arg only to match write_chunk() */
1376 cutthrough_write_chunk(transport_ctx * tctx, uschar * s, int len)
1379 while(s && (s2 = Ustrchr(s, '\n')))
1381 if(!cutthrough_puts(s, s2-s) || !cutthrough_put_nl())
1389 /* Buffered send of headers. Return success boolean. */
1390 /* Expands newlines to wire format (CR,NL). */
1391 /* Also sends header-terminating blank line. */
1393 cutthrough_headers_send(void)
1397 if(cutthrough.cctx.sock < 0 || cutthrough.callout_hold_only)
1400 /* We share a routine with the mainline transport to handle header add/remove/rewrites,
1401 but having a separate buffered-output function (for now)
1403 HDEBUG(D_acl) debug_printf_indent("----------- start cutthrough headers send -----------\n");
1405 tctx.u.fd = cutthrough.cctx.sock;
1406 tctx.tblock = cutthrough.addr.transport;
1407 tctx.addr = &cutthrough.addr;
1408 tctx.check_string = US".";
1409 tctx.escape_string = US"..";
1410 /*XXX check under spool_files_wireformat. Might be irrelevant */
1411 tctx.options = topt_use_crlf;
1413 if (!transport_headers_send(&tctx, &cutthrough_write_chunk))
1416 HDEBUG(D_acl) debug_printf_indent("----------- done cutthrough headers send ------------\n");
1422 close_cutthrough_connection(const uschar * why)
1424 int fd = cutthrough.cctx.sock;
1427 /* We could be sending this after a bunch of data, but that is ok as
1428 the only way to cancel the transfer in dataphase is to drop the tcp
1429 conn before the final dot.
1431 client_conn_ctx tmp_ctx = cutthrough.cctx;
1432 ctctx.outblock.ptr = ctbuffer;
1433 HDEBUG(D_transport|D_acl|D_v) debug_printf_indent(" SMTP>> QUIT\n");
1434 _cutthrough_puts(US"QUIT\r\n", 6); /* avoid recursion */
1435 _cutthrough_flush_send();
1436 cutthrough.cctx.sock = -1; /* avoid recursion via read timeout */
1437 cutthrough.nrcpt = 0; /* permit re-cutthrough on subsequent message */
1439 /* Wait a short time for response, and discard it */
1440 cutthrough_response(&tmp_ctx, '2', NULL, 1);
1443 if (cutthrough.is_tls)
1445 tls_close(cutthrough.cctx.tls_ctx, TLS_SHUTDOWN_NOWAIT);
1446 cutthrough.cctx.tls_ctx = NULL;
1447 cutthrough.is_tls = FALSE;
1450 HDEBUG(D_transport|D_acl|D_v) debug_printf_indent(" SMTP(close)>>\n");
1452 HDEBUG(D_acl) debug_printf_indent("----------- cutthrough shutdown (%s) ------------\n", why);
1454 ctctx.outblock.ptr = ctbuffer;
1458 cancel_cutthrough_connection(BOOL close_noncutthrough_verifies, const uschar * why)
1460 if (cutthrough.delivery || close_noncutthrough_verifies)
1461 close_cutthrough_connection(why);
1462 cutthrough.delivery = cutthrough.callout_hold_only = FALSE;
1467 release_cutthrough_connection(const uschar * why)
1469 if (cutthrough.cctx.sock < 0) return;
1470 HDEBUG(D_acl) debug_printf_indent("release cutthrough conn: %s\n", why);
1471 cutthrough.cctx.sock = -1;
1472 cutthrough.cctx.tls_ctx = NULL;
1473 cutthrough.delivery = cutthrough.callout_hold_only = FALSE;
1479 /* Have senders final-dot. Send one to cutthrough target, and grab the response.
1480 Log an OK response as a transmission.
1481 Close the connection.
1482 Return smtp response-class digit.
1485 cutthrough_finaldot(void)
1488 HDEBUG(D_transport|D_acl|D_v) debug_printf_indent(" SMTP>> .\n");
1490 /* Assume data finshed with new-line */
1491 if( !cutthrough_puts(US".", 1)
1492 || !cutthrough_put_nl()
1493 || !cutthrough_flush_send()
1495 return cutthrough.addr.message;
1497 res = cutthrough_response(&cutthrough.cctx, '2', &cutthrough.addr.message,
1498 CUTTHROUGH_DATA_TIMEOUT);
1499 for (address_item * addr = &cutthrough.addr; addr; addr = addr->next)
1501 addr->message = cutthrough.addr.message;
1505 delivery_log(LOG_MAIN, addr, (int)'>', NULL);
1506 close_cutthrough_connection(US"delivered");
1510 delivery_log(LOG_MAIN, addr, 0,
1511 US"tmp-reject from cutthrough after DATA:");
1515 delivery_log(LOG_MAIN|LOG_REJECT, addr, 0,
1516 US"rejected after DATA:");
1523 return cutthrough.addr.message;
1528 /*************************************************
1529 * Copy error to toplevel address *
1530 *************************************************/
1532 /* This function is used when a verify fails or defers, to ensure that the
1533 failure or defer information is in the original toplevel address. This applies
1534 when an address is redirected to a single new address, and the failure or
1535 deferral happens to the child address.
1538 vaddr the verify address item
1539 addr the final address item
1542 Returns: the value of YIELD
1546 copy_error(address_item *vaddr, address_item *addr, int yield)
1550 vaddr->message = addr->message;
1551 vaddr->user_message = addr->user_message;
1552 vaddr->basic_errno = addr->basic_errno;
1553 vaddr->more_errno = addr->more_errno;
1554 vaddr->prop.address_data = addr->prop.address_data;
1555 vaddr->prop.variables = NULL;
1556 tree_dup((tree_node **)&vaddr->prop.variables, addr->prop.variables);
1557 copyflag(vaddr, addr, af_pass_message);
1565 /**************************************************
1566 * printf that automatically handles TLS if needed *
1567 ***************************************************/
1569 /* This function is used by verify_address() as a substitute for all fprintf()
1570 calls; a direct fprintf() will not produce output in a TLS SMTP session, such
1571 as a response to an EXPN command. smtp_in.c makes smtp_printf available but
1572 that assumes that we always use the smtp_out FILE* when not using TLS or the
1573 ssl buffer when we are. Instead we take a FILE* parameter and check to see if
1574 that is smtp_out; if so, smtp_printf() with TLS support, otherwise regular
1578 f the candidate FILE* to write to
1579 format format string
1580 ... optional arguments
1586 static void PRINTF_FUNCTION(2,3)
1587 respond_printf(FILE *f, const char *format, ...)
1591 va_start(ap, format);
1592 if (smtp_out && (f == smtp_out))
1593 smtp_vprintf(format, FALSE, ap);
1595 vfprintf(f, format, ap);
1601 /*************************************************
1602 * Verify an email address *
1603 *************************************************/
1605 /* This function is used both for verification (-bv and at other times) and
1606 address testing (-bt), which is indicated by address_test_mode being set.
1609 vaddr contains the address to verify; the next field in this block
1611 f if not NULL, write the result to this file
1612 options various option bits:
1613 vopt_fake_sender => this sender verify is not for the real
1614 sender (it was verify=sender=xxxx or an address from a
1615 header line) - rewriting must not change sender_address
1616 vopt_is_recipient => this is a recipient address, otherwise
1617 it's a sender address - this affects qualification and
1618 rewriting and messages from callouts
1619 vopt_qualify => qualify an unqualified address; else error
1620 vopt_expn => called from SMTP EXPN command
1621 vopt_success_on_redirect => when a new address is generated
1622 the verification instantly succeeds
1624 These ones are used by do_callout() -- the options variable
1627 vopt_callout_fullpm => if postmaster check, do full one
1628 vopt_callout_no_cache => don't use callout cache
1629 vopt_callout_random => do the "random" thing
1630 vopt_callout_recipsender => use real sender for recipient
1631 vopt_callout_recippmaster => use postmaster for recipient
1633 callout if > 0, specifies that callout is required, and gives timeout
1634 for individual commands
1635 callout_overall if > 0, gives overall timeout for the callout function;
1636 if < 0, a default is used (see do_callout())
1637 callout_connect the connection timeout for callouts
1638 se_mailfrom when callout is requested to verify a sender, use this
1639 in MAIL FROM; NULL => ""
1640 pm_mailfrom when callout is requested, if non-NULL, do the postmaster
1641 thing and use this as the sender address (may be "")
1643 routed if not NULL, set TRUE if routing succeeded, so we can
1644 distinguish between routing failed and callout failed
1646 Returns: OK address verified
1647 FAIL address failed to verify
1648 DEFER can't tell at present
1652 verify_address(address_item * vaddr, FILE * fp, int options, int callout,
1653 int callout_overall, int callout_connect, uschar * se_mailfrom,
1654 uschar *pm_mailfrom, BOOL *routed)
1657 BOOL full_info = fp ? debug_selector != 0 : FALSE;
1658 BOOL expn = (options & vopt_expn) != 0;
1659 BOOL success_on_redirect = (options & vopt_success_on_redirect) != 0;
1662 int verify_type = expn? v_expn :
1663 f.address_test_mode? v_none :
1664 options & vopt_is_recipient? v_recipient : v_sender;
1665 address_item *addr_list;
1666 address_item *addr_new = NULL;
1667 address_item *addr_remote = NULL;
1668 address_item *addr_local = NULL;
1669 address_item *addr_succeed = NULL;
1670 uschar **failure_ptr = options & vopt_is_recipient
1671 ? &recipient_verify_failure : &sender_verify_failure;
1672 uschar *ko_prefix, *cr;
1673 uschar *address = vaddr->address;
1674 uschar *save_sender;
1675 uschar null_sender[] = { 0 }; /* Ensure writeable memory */
1677 /* Clear, just in case */
1679 *failure_ptr = NULL;
1681 /* Set up a prefix and suffix for error message which allow us to use the same
1682 output statements both in EXPN mode (where an SMTP response is needed) and when
1683 debugging with an output file. */
1687 ko_prefix = US"553 ";
1690 else ko_prefix = cr = US"";
1692 /* Add qualify domain if permitted; otherwise an unqualified address fails. */
1694 if (parse_find_at(address) == NULL)
1696 if (!(options & vopt_qualify))
1699 respond_printf(fp, "%sA domain is required for \"%s\"%s\n",
1700 ko_prefix, address, cr);
1701 *failure_ptr = US"qualify";
1704 address = rewrite_address_qualify(address, options & vopt_is_recipient);
1709 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
1710 debug_printf("%s %s\n", f.address_test_mode? "Testing" : "Verifying", address);
1713 /* Rewrite and report on it. Clear the domain and local part caches - these
1714 may have been set by domains and local part tests during an ACL. */
1716 if (global_rewrite_rules)
1718 uschar *old = address;
1719 address = rewrite_address(address, options & vopt_is_recipient, FALSE,
1720 global_rewrite_rules, rewrite_existflags);
1723 for (int i = 0; i < (MAX_NAMED_LIST * 2)/32; i++) vaddr->localpart_cache[i] = 0;
1724 for (int i = 0; i < (MAX_NAMED_LIST * 2)/32; i++) vaddr->domain_cache[i] = 0;
1725 if (fp && !expn) fprintf(fp, "Address rewritten as: %s\n", address);
1729 /* If this is the real sender address, we must update sender_address at
1730 this point, because it may be referred to in the routers. */
1732 if (!(options & (vopt_fake_sender|vopt_is_recipient)))
1733 sender_address = address;
1735 /* If the address was rewritten to <> no verification can be done, and we have
1736 to return OK. This rewriting is permitted only for sender addresses; for other
1737 addresses, such rewriting fails. */
1739 if (!address[0]) return OK;
1741 /* Flip the legacy TLS-related variables over to the outbound set in case
1742 they're used in the context of a transport used by verification. Reset them
1743 at exit from this routine (so no returns allowed from here on). */
1745 tls_modify_variables(&tls_out);
1747 /* Save a copy of the sender address for re-instating if we change it to <>
1748 while verifying a sender address (a nice bit of self-reference there). */
1750 save_sender = sender_address;
1752 /* Observability variable for router/transport use */
1754 verify_mode = options & vopt_is_recipient ? US"R" : US"S";
1756 /* Update the address structure with the possibly qualified and rewritten
1757 address. Set it up as the starting address on the chain of new addresses. */
1759 vaddr->address = address;
1762 /* We need a loop, because an address can generate new addresses. We must also
1763 cope with generated pipes and files at the top level. (See also the code and
1764 comment in deliver.c.) However, it is usually the case that the router for
1765 user's .forward files has its verify flag turned off.
1767 If an address generates more than one child, the loop is used only when
1768 full_info is set, and this can only be set locally. Remote enquiries just get
1769 information about the top level address, not anything that it generated. */
1774 address_item *addr = addr_new;
1776 addr_new = addr->next;
1781 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
1782 debug_printf("Considering %s\n", addr->address);
1785 /* Handle generated pipe, file or reply addresses. We don't get these
1786 when handling EXPN, as it does only one level of expansion. */
1788 if (testflag(addr, af_pfr))
1795 if (addr->address[0] == '>')
1797 allow = testflag(addr, af_allow_reply);
1798 fprintf(fp, "%s -> mail %s", addr->parent->address, addr->address + 1);
1802 allow = addr->address[0] == '|'
1803 ? testflag(addr, af_allow_pipe) : testflag(addr, af_allow_file);
1804 fprintf(fp, "%s -> %s", addr->parent->address, addr->address);
1807 if (addr->basic_errno == ERRNO_BADTRANSPORT)
1808 fprintf(fp, "\n*** Error in setting up pipe, file, or autoreply:\n"
1809 "%s\n", addr->message);
1811 fprintf(fp, "\n transport = %s\n", addr->transport->name);
1813 fprintf(fp, " *** forbidden ***\n");
1818 /* Just in case some router parameter refers to it. */
1820 return_path = addr->prop.errors_address
1821 ? addr->prop.errors_address : sender_address;
1823 /* Split the address into domain and local part, handling the %-hack if
1824 necessary, and then route it. While routing a sender address, set
1825 $sender_address to <> because that is what it will be if we were trying to
1826 send a bounce to the sender. */
1828 if (routed) *routed = FALSE;
1829 if ((rc = deliver_split_address(addr)) == OK)
1831 if (!(options & vopt_is_recipient)) sender_address = null_sender;
1832 rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
1833 &addr_succeed, verify_type);
1834 sender_address = save_sender; /* Put back the real sender */
1837 /* If routing an address succeeded, set the flag that remembers, for use when
1838 an ACL cached a sender verify (in case a callout fails). Then if routing set
1839 up a list of hosts or the transport has a host list, and the callout option
1840 is set, and we aren't in a host checking run, do the callout verification,
1841 and set another flag that notes that a callout happened. */
1845 if (routed) *routed = TRUE;
1848 transport_instance * tp;
1849 host_item * host_list = addr->host_list;
1851 /* Make up some data for use in the case where there is no remote
1854 transport_feedback tf = {
1855 .interface = NULL, /* interface (=> any) */
1857 .protocol = US"smtp",
1859 .helo_data = US"$smtp_active_hostname",
1860 .hosts_override = FALSE,
1861 .hosts_randomize = FALSE,
1862 .gethostbyname = FALSE,
1863 .qualify_single = TRUE,
1864 .search_parents = FALSE
1867 /* If verification yielded a remote transport, we want to use that
1868 transport's options, so as to mimic what would happen if we were really
1869 sending a message to this address. */
1871 if ((tp = addr->transport) && !tp->info->local)
1873 (void)(tp->setup)(tp, addr, &tf, 0, 0, NULL);
1875 /* If the transport has hosts and the router does not, or if the
1876 transport is configured to override the router's hosts, we must build a
1877 host list of the transport's hosts, and find the IP addresses */
1879 if (tf.hosts && (!host_list || tf.hosts_override))
1882 const uschar *save_deliver_domain = deliver_domain;
1883 uschar *save_deliver_localpart = deliver_localpart;
1885 host_list = NULL; /* Ignore the router's hosts */
1887 deliver_domain = addr->domain;
1888 deliver_localpart = addr->local_part;
1889 s = expand_string(tf.hosts);
1890 deliver_domain = save_deliver_domain;
1891 deliver_localpart = save_deliver_localpart;
1895 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand list of hosts "
1896 "\"%s\" in %s transport for callout: %s", tf.hosts,
1897 tp->name, expand_string_message);
1902 host_build_hostlist(&host_list, s, tf.hosts_randomize);
1904 /* Just ignore failures to find a host address. If we don't manage
1905 to find any addresses, the callout will defer. Note that more than
1906 one address may be found for a single host, which will result in
1907 additional host items being inserted into the chain. Hence we must
1908 save the next host first. */
1910 flags = HOST_FIND_BY_A | HOST_FIND_BY_AAAA;
1911 if (tf.qualify_single) flags |= HOST_FIND_QUALIFY_SINGLE;
1912 if (tf.search_parents) flags |= HOST_FIND_SEARCH_PARENTS;
1914 for (host_item * host = host_list, * nexthost; host; host = nexthost)
1916 nexthost = host->next;
1917 if (tf.gethostbyname ||
1918 string_is_ip_address(host->name, NULL) != 0)
1919 (void)host_find_byname(host, NULL, flags, NULL, TRUE);
1922 const dnssec_domains * dsp = NULL;
1923 if (Ustrcmp(tp->driver_name, "smtp") == 0)
1925 smtp_transport_options_block * ob =
1926 (smtp_transport_options_block *) tp->options_block;
1930 (void) host_find_bydns(host, NULL, flags, NULL, NULL, NULL,
1938 /* Can only do a callout if we have at least one host! If the callout
1939 fails, it will have set ${sender,recipient}_verify_failure. */
1943 HDEBUG(D_verify) debug_printf("Attempting full verification using callout\n");
1944 if (host_checking && !f.host_checking_callout)
1947 debug_printf("... callout omitted by default when host testing\n"
1948 "(Use -bhc if you want the callouts to happen.)\n");
1953 deliver_set_expansions(addr);
1955 rc = do_callout(addr, host_list, &tf, callout, callout_overall,
1956 callout_connect, options, se_mailfrom, pm_mailfrom);
1958 deliver_set_expansions(NULL);
1964 HDEBUG(D_verify) debug_printf("Cannot do callout: neither router nor "
1965 "transport provided a host list, or transport is not smtp\n");
1970 /* Otherwise, any failure is a routing failure */
1972 else *failure_ptr = US"route";
1974 /* A router may return REROUTED if it has set up a child address as a result
1975 of a change of domain name (typically from widening). In this case we always
1976 want to continue to verify the new child. */
1978 if (rc == REROUTED) continue;
1980 /* Handle hard failures */
1987 address_item *p = addr->parent;
1989 respond_printf(fp, "%s%s %s", ko_prefix,
1990 full_info ? addr->address : address,
1991 f.address_test_mode ? "is undeliverable" : "failed to verify");
1992 if (!expn && f.admin_user)
1994 if (addr->basic_errno > 0)
1995 respond_printf(fp, ": %s", strerror(addr->basic_errno));
1997 respond_printf(fp, ": %s", addr->message);
2000 /* Show parents iff doing full info */
2002 if (full_info) while (p)
2004 respond_printf(fp, "%s\n <-- %s", cr, p->address);
2007 respond_printf(fp, "%s\n", cr);
2009 cancel_cutthrough_connection(TRUE, US"routing hard fail");
2013 yield = copy_error(vaddr, addr, FAIL);
2021 else if (rc == DEFER)
2026 address_item *p = addr->parent;
2027 respond_printf(fp, "%s%s cannot be resolved at this time", ko_prefix,
2028 full_info? addr->address : address);
2029 if (!expn && f.admin_user)
2031 if (addr->basic_errno > 0)
2032 respond_printf(fp, ": %s", strerror(addr->basic_errno));
2034 respond_printf(fp, ": %s", addr->message);
2035 else if (addr->basic_errno <= 0)
2036 respond_printf(fp, ": unknown error");
2039 /* Show parents iff doing full info */
2041 if (full_info) while (p)
2043 respond_printf(fp, "%s\n <-- %s", cr, p->address);
2046 respond_printf(fp, "%s\n", cr);
2048 cancel_cutthrough_connection(TRUE, US"routing soft fail");
2052 yield = copy_error(vaddr, addr, DEFER);
2055 if (yield == OK) yield = DEFER;
2058 /* If we are handling EXPN, we do not want to continue to route beyond
2059 the top level (whose address is in "address"). */
2063 uschar *ok_prefix = US"250-";
2066 if (!addr_local && !addr_remote)
2067 respond_printf(fp, "250 mail to <%s> is discarded\r\n", address);
2069 respond_printf(fp, "250 <%s>\r\n", address);
2073 address_item *addr2 = addr_new;
2074 addr_new = addr2->next;
2075 if (!addr_new) ok_prefix = US"250 ";
2076 respond_printf(fp, "%s<%s>\r\n", ok_prefix, addr2->address);
2082 /* Successful routing other than EXPN. */
2086 /* Handle successful routing when short info wanted. Otherwise continue for
2087 other (generated) addresses. Short info is the operational case. Full info
2088 can be requested only when debug_selector != 0 and a file is supplied.
2090 There is a conflict between the use of aliasing as an alternate email
2091 address, and as a sort of mailing list. If an alias turns the incoming
2092 address into just one address (e.g. J.Caesar->jc44) you may well want to
2093 carry on verifying the generated address to ensure it is valid when
2094 checking incoming mail. If aliasing generates multiple addresses, you
2095 probably don't want to do this. Exim therefore treats the generation of
2096 just a single new address as a special case, and continues on to verify the
2097 generated address. */
2099 if ( !full_info /* Stop if short info wanted AND */
2100 && ( ( !addr_new /* No new address OR */
2101 || addr_new->next /* More than one new address OR */
2102 || testflag(addr_new, af_pfr) /* New address is pfr */
2105 ( addr_new /* At least one new address AND */
2106 && success_on_redirect /* success_on_redirect is set */
2110 if (fp) fprintf(fp, "%s %s\n",
2111 address, f.address_test_mode ? "is deliverable" : "verified");
2113 /* If we have carried on to verify a child address, we want the value
2114 of $address_data to be that of the child */
2116 vaddr->prop.address_data = addr->prop.address_data;
2117 vaddr->prop.variables = NULL;
2118 tree_dup((tree_node **)&vaddr->prop.variables, addr->prop.variables);
2120 /* If stopped because more than one new address, cannot cutthrough */
2122 if (addr_new && addr_new->next)
2123 cancel_cutthrough_connection(TRUE, US"multiple addresses from routing");
2129 } /* Loop for generated addresses */
2131 /* Display the full results of the successful routing, including any generated
2132 addresses. Control gets here only when full_info is set, which requires fp not
2133 to be NULL, and this occurs only when a top-level verify is called with the
2134 debugging switch on.
2136 If there are no local and no remote addresses, and there were no pipes, files,
2137 or autoreplies, and there were no errors or deferments, the message is to be
2138 discarded, usually because of the use of :blackhole: in an alias file. */
2140 if (allok && !addr_local && !addr_remote)
2142 fprintf(fp, "mail to %s is discarded\n", address);
2146 for (addr_list = addr_local, i = 0; i < 2; addr_list = addr_remote, i++)
2149 address_item *addr = addr_list;
2150 transport_instance * tp = addr->transport;
2152 addr_list = addr->next;
2154 fprintf(fp, "%s", CS addr->address);
2155 #ifdef EXPERIMENTAL_SRS
2156 if(addr->prop.srs_sender)
2157 fprintf(fp, " [srs = %s]", addr->prop.srs_sender);
2160 /* If the address is a duplicate, show something about it. */
2162 if (!testflag(addr, af_pfr))
2165 if ((tnode = tree_search(tree_duplicates, addr->unique)))
2166 fprintf(fp, " [duplicate, would not be delivered]");
2167 else tree_add_duplicate(addr->unique, addr);
2170 /* Now show its parents */
2172 for (address_item * p = addr->parent; p; p = p->parent)
2173 fprintf(fp, "\n <-- %s", p->address);
2176 /* Show router, and transport */
2178 fprintf(fp, "router = %s, transport = %s\n",
2179 addr->router->name, tp ? tp->name : US"unset");
2181 /* Show any hosts that are set up by a router unless the transport
2182 is going to override them; fiddle a bit to get a nice format. */
2184 if (addr->host_list && tp && !tp->overrides_hosts)
2188 for (host_item * h = addr->host_list; h; h = h->next)
2189 { /* get max lengths of host names, addrs */
2190 int len = Ustrlen(h->name);
2191 if (len > maxlen) maxlen = len;
2192 len = h->address ? Ustrlen(h->address) : 7;
2193 if (len > maxaddlen) maxaddlen = len;
2195 for (host_item * h = addr->host_list; h; h = h->next)
2197 fprintf(fp, " host %-*s ", maxlen, h->name);
2200 fprintf(fp, "[%s%-*c", h->address, maxaddlen+1 - Ustrlen(h->address), ']');
2201 else if (tp->info->local)
2202 fprintf(fp, " %-*s ", maxaddlen, ""); /* Omit [unknown] for local */
2204 fprintf(fp, "[%s%-*c", "unknown", maxaddlen+1 - 7, ']');
2206 if (h->mx >= 0) fprintf(fp, " MX=%d", h->mx);
2207 if (h->port != PORT_NONE) fprintf(fp, " port=%d", h->port);
2208 if (f.running_in_test_harness && h->dnssec == DS_YES) fputs(" AD", fp);
2209 if (h->status == hstatus_unusable) fputs(" ** unusable **", fp);
2215 /* Yield will be DEFER or FAIL if any one address has, only for full_info (which is
2216 the -bv or -bt case). */
2220 tls_modify_variables(&tls_in); /* return variables to inbound values */
2228 /*************************************************
2229 * Check headers for syntax errors *
2230 *************************************************/
2232 /* This function checks those header lines that contain addresses, and verifies
2233 that all the addresses therein are 5322-syntactially correct.
2236 msgptr where to put an error message
2243 verify_check_headers(uschar **msgptr)
2248 for (header_line * h = header_list; h && yield == OK; h = h->next)
2250 if (h->type != htype_from &&
2251 h->type != htype_reply_to &&
2252 h->type != htype_sender &&
2253 h->type != htype_to &&
2254 h->type != htype_cc &&
2255 h->type != htype_bcc)
2258 colon = Ustrchr(h->text, ':');
2260 while (isspace(*s)) s++;
2262 /* Loop for multiple addresses in the header, enabling group syntax. Note
2263 that we have to reset this after the header has been scanned. */
2265 f.parse_allow_group = TRUE;
2269 uschar *ss = parse_find_address_end(s, FALSE);
2270 uschar *recipient, *errmess;
2271 int terminator = *ss;
2272 int start, end, domain;
2274 /* Temporarily terminate the string at this point, and extract the
2275 operative address within, allowing group syntax. */
2278 recipient = parse_extract_address(s,&errmess,&start,&end,&domain,FALSE);
2281 /* Permit an unqualified address only if the message is local, or if the
2282 sending host is configured to be permitted to send them. */
2284 if (recipient && !domain)
2286 if (h->type == htype_from || h->type == htype_sender)
2288 if (!f.allow_unqualified_sender) recipient = NULL;
2292 if (!f.allow_unqualified_recipient) recipient = NULL;
2294 if (recipient == NULL) errmess = US"unqualified address not permitted";
2297 /* It's an error if no address could be extracted, except for the special
2298 case of an empty address. */
2300 if (!recipient && Ustrcmp(errmess, "empty address") != 0)
2302 uschar *verb = US"is";
2307 /* Arrange not to include any white space at the end in the
2308 error message or the header name. */
2310 while (t > s && isspace(t[-1])) t--;
2311 while (tt > h->text && isspace(tt[-1])) tt--;
2313 /* Add the address that failed to the error message, since in a
2314 header with very many addresses it is sometimes hard to spot
2315 which one is at fault. However, limit the amount of address to
2316 quote - cases have been seen where, for example, a missing double
2317 quote in a humungous To: header creates an "address" that is longer
2318 than string_sprintf can handle. */
2327 /* deconst cast ok as we're passing a non-const to string_printing() */
2328 *msgptr = US string_printing(
2329 string_sprintf("%s: failing address in \"%.*s:\" header %s: %.*s",
2330 errmess, (int)(tt - h->text), h->text, verb, len, s));
2333 break; /* Out of address loop */
2336 /* Advance to the next address */
2338 s = ss + (terminator ? 1 : 0);
2339 while (isspace(*s)) s++;
2340 } /* Next address */
2342 f.parse_allow_group = FALSE;
2343 f.parse_found_group = FALSE;
2344 } /* Next header unless yield has been set FALSE */
2350 /*************************************************
2351 * Check header names for 8-bit characters *
2352 *************************************************/
2354 /* This function checks for invalid characters in header names. See
2355 RFC 5322, 2.2. and RFC 6532, 3.
2358 msgptr where to put an error message
2365 verify_check_header_names_ascii(uschar **msgptr)
2369 for (header_line * h = header_list; h; h = h->next)
2371 colon = Ustrchr(h->text, ':');
2372 for(uschar * s = h->text; s < colon; s++)
2373 if ((*s < 33) || (*s > 126))
2375 *msgptr = string_sprintf("Invalid character in header \"%.*s\" found",
2376 (int)(colon - h->text), h->text);
2383 /*************************************************
2384 * Check for blind recipients *
2385 *************************************************/
2387 /* This function checks that every (envelope) recipient is mentioned in either
2388 the To: or Cc: header lines, thus detecting blind carbon copies.
2390 There are two ways of scanning that could be used: either scan the header lines
2391 and tick off the recipients, or scan the recipients and check the header lines.
2392 The original proposed patch did the former, but I have chosen to do the latter,
2393 because (a) it requires no memory and (b) will use fewer resources when there
2394 are many addresses in To: and/or Cc: and only one or two envelope recipients.
2396 Arguments: case_sensitive true if case sensitive matching should be used
2397 Returns: OK if there are no blind recipients
2398 FAIL if there is at least one blind recipient
2402 verify_check_notblind(BOOL case_sensitive)
2404 for (int i = 0; i < recipients_count; i++)
2407 uschar *address = recipients_list[i].address;
2409 for (header_line * h = header_list; !found && h; h = h->next)
2413 if (h->type != htype_to && h->type != htype_cc) continue;
2415 colon = Ustrchr(h->text, ':');
2417 while (isspace(*s)) s++;
2419 /* Loop for multiple addresses in the header, enabling group syntax. Note
2420 that we have to reset this after the header has been scanned. */
2422 f.parse_allow_group = TRUE;
2426 uschar * ss = parse_find_address_end(s, FALSE);
2427 uschar * recipient, * errmess;
2428 int terminator = *ss;
2429 int start, end, domain;
2431 /* Temporarily terminate the string at this point, and extract the
2432 operative address within, allowing group syntax. */
2435 recipient = parse_extract_address(s,&errmess,&start,&end,&domain,FALSE);
2438 /* If we found a valid recipient that has a domain, compare it with the
2439 envelope recipient. Local parts are compared with case-sensitivity
2440 according to the routine arg, domains case-insensitively.
2441 By comparing from the start with length "domain", we include the "@" at
2442 the end, which ensures that we are comparing the whole local part of each
2445 if (recipient && domain != 0)
2446 if ((found = (case_sensitive
2447 ? Ustrncmp(recipient, address, domain) == 0
2448 : strncmpic(recipient, address, domain) == 0)
2449 && strcmpic(recipient + domain, address + domain) == 0))
2452 /* Advance to the next address */
2454 s = ss + (terminator ? 1:0);
2455 while (isspace(*s)) s++;
2456 } /* Next address */
2458 f.parse_allow_group = FALSE;
2459 f.parse_found_group = FALSE;
2460 } /* Next header (if found is false) */
2462 if (!found) return FAIL;
2463 } /* Next recipient */
2470 /*************************************************
2471 * Find if verified sender *
2472 *************************************************/
2474 /* Usually, just a single address is verified as the sender of the message.
2475 However, Exim can be made to verify other addresses as well (often related in
2476 some way), and this is useful in some environments. There may therefore be a
2477 chain of such addresses that have previously been tested. This function finds
2478 whether a given address is on the chain.
2480 Arguments: the address to be verified
2481 Returns: pointer to an address item, or NULL
2485 verify_checked_sender(uschar *sender)
2487 for (address_item * addr = sender_verified_list; addr; addr = addr->next)
2488 if (Ustrcmp(sender, addr->address) == 0) return addr;
2496 /*************************************************
2497 * Get valid header address *
2498 *************************************************/
2500 /* Scan the originator headers of the message, looking for an address that
2501 verifies successfully. RFC 822 says:
2503 o The "Sender" field mailbox should be sent notices of
2504 any problems in transport or delivery of the original
2505 messages. If there is no "Sender" field, then the
2506 "From" field mailbox should be used.
2508 o If the "Reply-To" field exists, then the reply should
2509 go to the addresses indicated in that field and not to
2510 the address(es) indicated in the "From" field.
2512 So we check a Sender field if there is one, else a Reply_to field, else a From
2513 field. As some strange messages may have more than one of these fields,
2514 especially if they are resent- fields, check all of them if there is more than
2518 user_msgptr points to where to put a user error message
2519 log_msgptr points to where to put a log error message
2520 callout timeout for callout check (passed to verify_address())
2521 callout_overall overall callout timeout (ditto)
2522 callout_connect connect callout timeout (ditto)
2523 se_mailfrom mailfrom for verify; NULL => ""
2524 pm_mailfrom sender for pm callout check (passed to verify_address())
2525 options callout options (passed to verify_address())
2526 verrno where to put the address basic_errno
2528 If log_msgptr is set to something without setting user_msgptr, the caller
2529 normally uses log_msgptr for both things.
2531 Returns: result of the verification attempt: OK, FAIL, or DEFER;
2532 FAIL is given if no appropriate headers are found
2536 verify_check_header_address(uschar **user_msgptr, uschar **log_msgptr,
2537 int callout, int callout_overall, int callout_connect, uschar *se_mailfrom,
2538 uschar *pm_mailfrom, int options, int *verrno)
2540 static int header_types[] = { htype_sender, htype_reply_to, htype_from };
2544 for (int i = 0; i < 3 && !done; i++)
2545 for (header_line * h = header_list; h != NULL && !done; h = h->next)
2547 int terminator, new_ok;
2548 uschar *s, *ss, *endname;
2550 if (h->type != header_types[i]) continue;
2551 s = endname = Ustrchr(h->text, ':') + 1;
2553 /* Scan the addresses in the header, enabling group syntax. Note that we
2554 have to reset this after the header has been scanned. */
2556 f.parse_allow_group = TRUE;
2560 address_item *vaddr;
2562 while (isspace(*s) || *s == ',') s++;
2563 if (*s == 0) break; /* End of header */
2565 ss = parse_find_address_end(s, FALSE);
2567 /* The terminator is a comma or end of header, but there may be white
2568 space preceding it (including newline for the last address). Move back
2569 past any white space so we can check against any cached envelope sender
2570 address verifications. */
2572 while (isspace(ss[-1])) ss--;
2576 HDEBUG(D_verify) debug_printf("verifying %.*s header address %s\n",
2577 (int)(endname - h->text), h->text, s);
2579 /* See if we have already verified this address as an envelope sender,
2580 and if so, use the previous answer. */
2582 vaddr = verify_checked_sender(s);
2584 if (vaddr != NULL && /* Previously checked */
2585 (callout <= 0 || /* No callout needed; OR */
2586 vaddr->special_action > 256)) /* Callout was done */
2588 new_ok = vaddr->special_action & 255;
2589 HDEBUG(D_verify) debug_printf("previously checked as envelope sender\n");
2590 *ss = terminator; /* Restore shortened string */
2593 /* Otherwise we run the verification now. We must restore the shortened
2594 string before running the verification, so the headers are correct, in
2595 case there is any rewriting. */
2599 int start, end, domain;
2600 uschar *address = parse_extract_address(s, log_msgptr, &start, &end,
2605 /* If we found an empty address, just carry on with the next one, but
2606 kill the message. */
2608 if (address == NULL && Ustrcmp(*log_msgptr, "empty address") == 0)
2615 /* If verification failed because of a syntax error, fail this
2616 function, and ensure that the failing address gets added to the error
2619 if (address == NULL)
2622 while (ss > s && isspace(ss[-1])) ss--;
2623 *log_msgptr = string_sprintf("syntax error in '%.*s' header when "
2624 "scanning for sender: %s in \"%.*s\"",
2625 (int)(endname - h->text), h->text, *log_msgptr, (int)(ss - s), s);
2631 /* Else go ahead with the sender verification. But it isn't *the*
2632 sender of the message, so set vopt_fake_sender to stop sender_address
2633 being replaced after rewriting or qualification. */
2637 vaddr = deliver_make_addr(address, FALSE);
2638 new_ok = verify_address(vaddr, NULL, options | vopt_fake_sender,
2639 callout, callout_overall, callout_connect, se_mailfrom,
2644 /* We now have the result, either newly found, or cached. If we are
2645 giving out error details, set a specific user error. This means that the
2646 last of these will be returned to the user if all three fail. We do not
2647 set a log message - the generic one below will be used. */
2651 *verrno = vaddr->basic_errno;
2652 if (smtp_return_error_details)
2653 *user_msgptr = string_sprintf("Rejected after DATA: "
2654 "could not verify \"%.*s\" header address\n%s: %s",
2655 (int)(endname - h->text), h->text, vaddr->address, vaddr->message);
2658 /* Success or defer */
2667 if (new_ok == DEFER) yield = DEFER;
2669 /* Move on to any more addresses in the header */
2672 } /* Next address */
2674 f.parse_allow_group = FALSE;
2675 f.parse_found_group = FALSE;
2676 } /* Next header, unless done */
2677 /* Next header type unless done */
2679 if (yield == FAIL && *log_msgptr == NULL)
2680 *log_msgptr = US"there is no valid sender in any header line";
2682 if (yield == DEFER && *log_msgptr == NULL)
2683 *log_msgptr = US"all attempts to verify a sender in a header line deferred";
2691 /*************************************************
2692 * Get RFC 1413 identification *
2693 *************************************************/
2695 /* Attempt to get an id from the sending machine via the RFC 1413 protocol. If
2696 the timeout is set to zero, then the query is not done. There may also be lists
2697 of hosts and nets which are exempt. To guard against malefactors sending
2698 non-printing characters which could, for example, disrupt a message's headers,
2699 make sure the string consists of printing characters only.
2702 port the port to connect to; usually this is IDENT_PORT (113), but when
2703 running in the test harness with -bh a different value is used.
2707 Side effect: any received ident value is put in sender_ident (NULL otherwise)
2711 verify_get_ident(int port)
2713 client_conn_ctx ident_conn_ctx = {0};
2715 int received_sender_port, received_interface_port, n;
2718 uschar buffer[2048];
2720 /* Default is no ident. Check whether we want to do an ident check for this
2723 sender_ident = NULL;
2724 if (rfc1413_query_timeout <= 0 || verify_check_host(&rfc1413_hosts) != OK)
2727 DEBUG(D_ident) debug_printf("doing ident callback\n");
2729 /* Set up a connection to the ident port of the remote host. Bind the local end
2730 to the incoming interface address. If the sender host address is an IPv6
2731 address, the incoming interface address will also be IPv6. */
2733 host_af = Ustrchr(sender_host_address, ':') == NULL ? AF_INET : AF_INET6;
2734 if ((ident_conn_ctx.sock = ip_socket(SOCK_STREAM, host_af)) < 0) return;
2736 if (ip_bind(ident_conn_ctx.sock, host_af, interface_address, 0) < 0)
2738 DEBUG(D_ident) debug_printf("bind socket for ident failed: %s\n",
2743 /* Construct and send the query. */
2745 qlen = snprintf(CS buffer, sizeof(buffer), "%d , %d\r\n",
2746 sender_host_port, interface_port);
2747 early_data.data = buffer;
2748 early_data.len = qlen;
2750 /*XXX we trust that the query is idempotent */
2751 if (ip_connect(ident_conn_ctx.sock, host_af, sender_host_address, port,
2752 rfc1413_query_timeout, &early_data) < 0)
2754 if (errno == ETIMEDOUT && LOGGING(ident_timeout))
2755 log_write(0, LOG_MAIN, "ident connection to %s timed out",
2756 sender_host_address);
2758 DEBUG(D_ident) debug_printf("ident connection to %s failed: %s\n",
2759 sender_host_address, strerror(errno));
2763 /* Read a response line. We put it into the rest of the buffer, using several
2764 recv() calls if necessary. */
2772 int size = sizeof(buffer) - (p - buffer);
2774 if (size <= 0) goto END_OFF; /* Buffer filled without seeing \n. */
2775 count = ip_recv(&ident_conn_ctx, p, size, time(NULL) + rfc1413_query_timeout);
2776 if (count <= 0) goto END_OFF; /* Read error or EOF */
2778 /* Scan what we just read, to see if we have reached the terminating \r\n. Be
2779 generous, and accept a plain \n terminator as well. The only illegal
2782 for (pp = p; pp < p + count; pp++)
2784 if (*pp == 0) goto END_OFF; /* Zero octet not allowed */
2787 if (pp[-1] == '\r') pp--;
2789 goto GOT_DATA; /* Break out of both loops */
2793 /* Reached the end of the data without finding \n. Let the loop continue to
2794 read some more, if there is room. */
2801 /* We have received a line of data. Check it carefully. It must start with the
2802 same two port numbers that we sent, followed by data as defined by the RFC. For
2805 12345 , 25 : USERID : UNIX :root
2807 However, the amount of white space may be different to what we sent. In the
2808 "osname" field there may be several sub-fields, comma separated. The data we
2809 actually want to save follows the third colon. Some systems put leading spaces
2810 in it - we discard those. */
2812 if (sscanf(CS buffer + qlen, "%d , %d%n", &received_sender_port,
2813 &received_interface_port, &n) != 2 ||
2814 received_sender_port != sender_host_port ||
2815 received_interface_port != interface_port)
2818 p = buffer + qlen + n;
2819 while(isspace(*p)) p++;
2820 if (*p++ != ':') goto END_OFF;
2821 while(isspace(*p)) p++;
2822 if (Ustrncmp(p, "USERID", 6) != 0) goto END_OFF;
2824 while(isspace(*p)) p++;
2825 if (*p++ != ':') goto END_OFF;
2826 while (*p != 0 && *p != ':') p++;
2827 if (*p++ == 0) goto END_OFF;
2828 while(isspace(*p)) p++;
2829 if (*p == 0) goto END_OFF;
2831 /* The rest of the line is the data we want. We turn it into printing
2832 characters when we save it, so that it cannot mess up the format of any logging
2833 or Received: lines into which it gets inserted. We keep a maximum of 127
2834 characters. The deconst cast is ok as we fed a nonconst to string_printing() */
2836 sender_ident = US string_printing(string_copyn(p, 127));
2837 DEBUG(D_ident) debug_printf("sender_ident = %s\n", sender_ident);
2840 (void)close(ident_conn_ctx.sock);
2847 /*************************************************
2848 * Match host to a single host-list item *
2849 *************************************************/
2851 /* This function compares a host (name or address) against a single item
2852 from a host list. The host name gets looked up if it is needed and is not
2853 already known. The function is called from verify_check_this_host() via
2854 match_check_list(), which is why most of its arguments are in a single block.
2857 arg the argument block (see below)
2858 ss the host-list item
2859 valueptr where to pass back looked up data, or NULL
2860 error for error message when returning ERROR
2863 host_name (a) the host name, or
2864 (b) NULL, implying use sender_host_name and
2865 sender_host_aliases, looking them up if required, or
2866 (c) the empty string, meaning that only IP address matches
2868 host_address the host address
2869 host_ipv4 the IPv4 address taken from an IPv6 one
2873 DEFER lookup deferred
2874 ERROR (a) failed to find the host name or IP address, or
2875 (b) unknown lookup type specified, or
2876 (c) host name encountered when only IP addresses are
2881 check_host(void *arg, const uschar *ss, const uschar **valueptr, uschar **error)
2883 check_host_block *cb = (check_host_block *)arg;
2886 BOOL iplookup = FALSE;
2887 BOOL isquery = FALSE;
2888 BOOL isiponly = cb->host_name != NULL && cb->host_name[0] == 0;
2893 /* Optimize for the special case when the pattern is "*". */
2895 if (*ss == '*' && ss[1] == 0) return OK;
2897 /* If the pattern is empty, it matches only in the case when there is no host -
2898 this can occur in ACL checking for SMTP input using the -bs option. In this
2899 situation, the host address is the empty string. */
2901 if (cb->host_address[0] == 0) return (*ss == 0)? OK : FAIL;
2902 if (*ss == 0) return FAIL;
2904 /* If the pattern is precisely "@" then match against the primary host name,
2905 provided that host name matching is permitted; if it's "@[]" match against the
2906 local host's IP addresses. */
2912 if (isiponly) return ERROR;
2913 ss = primary_hostname;
2915 else if (Ustrcmp(ss, "@[]") == 0)
2917 for (ip_address_item * ip = host_find_interfaces(); ip; ip = ip->next)
2918 if (Ustrcmp(ip->address, cb->host_address) == 0) return OK;
2923 /* If the pattern is an IP address, optionally followed by a bitmask count, do
2924 a (possibly masked) comparison with the current IP address. */
2926 if (string_is_ip_address(ss, &maskoffset) != 0)
2927 return (host_is_in_net(cb->host_address, ss, maskoffset)? OK : FAIL);
2929 /* The pattern is not an IP address. A common error that people make is to omit
2930 one component of an IPv4 address, either by accident, or believing that, for
2931 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,
2932 which it isn't. (Those applications that do accept 1.2.3 as an IP address
2933 interpret it as 1.2.0.3 because the final component becomes 16-bit - this is an
2934 ancient specification.) To aid in debugging these cases, we give a specific
2935 error if the pattern contains only digits and dots or contains a slash preceded
2936 only by digits and dots (a slash at the start indicates a file name and of
2937 course slashes may be present in lookups, but not preceded only by digits and
2940 for (t = ss; isdigit(*t) || *t == '.'; ) t++;
2941 if (*t == 0 || (*t == '/' && t != ss))
2943 *error = US"malformed IPv4 address or address mask";
2947 /* See if there is a semicolon in the pattern */
2949 semicolon = Ustrchr(ss, ';');
2951 /* If we are doing an IP address only match, then all lookups must be IP
2952 address lookups, even if there is no "net-". */
2956 iplookup = semicolon != NULL;
2959 /* Otherwise, if the item is of the form net[n]-lookup;<file|query> then it is
2960 a lookup on a masked IP network, in textual form. We obey this code even if we
2961 have already set iplookup, so as to skip over the "net-" prefix and to set the
2962 mask length. The net- stuff really only applies to single-key lookups where the
2963 key is implicit. For query-style lookups the key is specified in the query.
2964 From release 4.30, the use of net- for query style is no longer needed, but we
2965 retain it for backward compatibility. */
2967 if (Ustrncmp(ss, "net", 3) == 0 && semicolon != NULL)
2970 for (t = ss + 3; isdigit(*t); t++) mlen = mlen * 10 + *t - '0';
2971 if (mlen == 0 && t == ss+3) mlen = -1; /* No mask supplied */
2972 iplookup = (*t++ == '-');
2977 /* Do the IP address lookup if that is indeed what we have */
2985 uschar *filename, *key, *result;
2988 /* Find the search type */
2990 search_type = search_findtype(t, semicolon - t);
2992 if (search_type < 0) log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s",
2993 search_error_message);
2995 /* Adjust parameters for the type of lookup. For a query-style lookup, there
2996 is no file name, and the "key" is just the query. For query-style with a file
2997 name, we have to fish the file off the start of the query. For a single-key
2998 lookup, the key is the current IP address, masked appropriately, and
2999 reconverted to text form, with the mask appended. For IPv6 addresses, specify
3000 dot separators instead of colons, except when the lookup type is "iplsearch".
3003 if (mac_islookup(search_type, lookup_absfilequery))
3005 filename = semicolon + 1;
3007 while (*key != 0 && !isspace(*key)) key++;
3008 filename = string_copyn(filename, key - filename);
3009 while (isspace(*key)) key++;
3011 else if (mac_islookup(search_type, lookup_querystyle))
3014 key = semicolon + 1;
3016 else /* Single-key style */
3018 int sep = (Ustrcmp(lookup_list[search_type]->name, "iplsearch") == 0)?
3020 insize = host_aton(cb->host_address, incoming);
3021 host_mask(insize, incoming, mlen);
3022 (void)host_nmtoa(insize, incoming, mlen, buffer, sep);
3024 filename = semicolon + 1;
3027 /* Now do the actual lookup; note that there is no search_close() because
3028 of the caching arrangements. */
3030 if (!(handle = search_open(filename, search_type, 0, NULL, NULL)))
3031 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", search_error_message);
3033 result = search_find(handle, filename, key, -1, NULL, 0, 0, NULL);
3034 if (valueptr) *valueptr = result;
3035 return result ? OK : f.search_find_defer ? DEFER: FAIL;
3038 /* The pattern is not an IP address or network reference of any kind. That is,
3039 it is a host name pattern. If this is an IP only match, there's an error in the
3044 *error = US"cannot match host name in match_ip list";
3048 /* Check the characters of the pattern to see if they comprise only letters,
3049 digits, full stops, and hyphens (the constituents of domain names). Allow
3050 underscores, as they are all too commonly found. Sigh. Also, if
3051 allow_utf8_domains is set, allow top-bit characters. */
3053 for (t = ss; *t != 0; t++)
3054 if (!isalnum(*t) && *t != '.' && *t != '-' && *t != '_' &&
3055 (!allow_utf8_domains || *t < 128)) break;
3057 /* If the pattern is a complete domain name, with no fancy characters, look up
3058 its IP address and match against that. Note that a multi-homed host will add
3059 items to the chain. */
3070 /* Using byname rather than bydns here means we cannot determine dnssec
3071 status. On the other hand it is unclear how that could be either
3072 propagated up or enforced. */
3074 rc = host_find_byname(&h, NULL, HOST_FIND_QUALIFY_SINGLE, NULL, FALSE);
3075 if (rc == HOST_FOUND || rc == HOST_FOUND_LOCAL)
3077 for (host_item * hh = &h; hh; hh = hh->next)
3078 if (host_is_in_net(hh->address, cb->host_address, 0)) return OK;
3081 if (rc == HOST_FIND_AGAIN) return DEFER;
3082 *error = string_sprintf("failed to find IP address for %s", ss);
3086 /* Almost all subsequent comparisons require the host name, and can be done
3087 using the general string matching function. When this function is called for
3088 outgoing hosts, the name is always given explicitly. If it is NULL, it means we
3089 must use sender_host_name and its aliases, looking them up if necessary. */
3091 if (cb->host_name != NULL) /* Explicit host name given */
3092 return match_check_string(cb->host_name, ss, -1, TRUE, TRUE, TRUE,
3095 /* Host name not given; in principle we need the sender host name and its
3096 aliases. However, for query-style lookups, we do not need the name if the
3097 query does not contain $sender_host_name. From release 4.23, a reference to
3098 $sender_host_name causes it to be looked up, so we don't need to do the lookup
3101 if ((semicolon = Ustrchr(ss, ';')) != NULL)
3103 const uschar *affix;
3104 int partial, affixlen, starflags, id;
3107 id = search_findtype_partial(ss, &partial, &affix, &affixlen, &starflags);
3110 if (id < 0) /* Unknown lookup type */
3112 log_write(0, LOG_MAIN|LOG_PANIC, "%s in host list item \"%s\"",
3113 search_error_message, ss);
3116 isquery = mac_islookup(id, lookup_querystyle|lookup_absfilequery);
3121 switch(match_check_string(US"", ss, -1, TRUE, TRUE, TRUE, valueptr))
3124 case DEFER: return DEFER;
3125 default: return FAIL;
3129 /* Not a query-style lookup; must ensure the host name is present, and then we
3130 do a check on the name and all its aliases. */
3132 if (!sender_host_name)
3134 HDEBUG(D_host_lookup)
3135 debug_printf("sender host name required, to match against %s\n", ss);
3136 if (host_lookup_failed || host_name_lookup() != OK)
3138 *error = string_sprintf("failed to find host name for %s",
3139 sender_host_address);;
3142 host_build_sender_fullhost();
3145 /* Match on the sender host name, using the general matching function */
3147 switch(match_check_string(sender_host_name, ss, -1, TRUE, TRUE, TRUE, valueptr))
3150 case DEFER: return DEFER;
3153 /* If there are aliases, try matching on them. */
3155 aliases = sender_host_aliases;
3157 switch(match_check_string(*aliases++, ss, -1, TRUE, TRUE, TRUE, valueptr))
3160 case DEFER: return DEFER;
3168 /*************************************************
3169 * Check a specific host matches a host list *
3170 *************************************************/
3172 /* This function is passed a host list containing items in a number of
3173 different formats and the identity of a host. Its job is to determine whether
3174 the given host is in the set of hosts defined by the list. The host name is
3175 passed as a pointer so that it can be looked up if needed and not already
3176 known. This is commonly the case when called from verify_check_host() to check
3177 an incoming connection. When called from elsewhere the host name should usually
3180 This function is now just a front end to match_check_list(), which runs common
3181 code for scanning a list. We pass it the check_host() function to perform a
3185 listptr pointer to the host list
3186 cache_bits pointer to cache for named lists, or NULL
3187 host_name the host name or NULL, implying use sender_host_name and
3188 sender_host_aliases, looking them up if required
3189 host_address the IP address
3190 valueptr if not NULL, data from a lookup is passed back here
3192 Returns: OK if the host is in the defined set
3193 FAIL if the host is not in the defined set,
3194 DEFER if a data lookup deferred (not a host lookup)
3196 If the host name was needed in order to make a comparison, and could not be
3197 determined from the IP address, the result is FAIL unless the item
3198 "+allow_unknown" was met earlier in the list, in which case OK is returned. */
3201 verify_check_this_host(const uschar **listptr, unsigned int *cache_bits,
3202 const uschar *host_name, const uschar *host_address, const uschar **valueptr)
3205 unsigned int *local_cache_bits = cache_bits;
3206 const uschar *save_host_address = deliver_host_address;
3207 check_host_block cb = { .host_name = host_name, .host_address = host_address };
3209 if (valueptr) *valueptr = NULL;
3211 /* If the host address starts off ::ffff: it is an IPv6 address in
3212 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3215 cb.host_ipv4 = Ustrncmp(host_address, "::ffff:", 7) == 0
3216 ? host_address + 7 : host_address;
3218 /* During the running of the check, put the IP address into $host_address. In
3219 the case of calls from the smtp transport, it will already be there. However,
3220 in other calls (e.g. when testing ignore_target_hosts), it won't. Just to be on
3221 the safe side, any existing setting is preserved, though as I write this
3222 (November 2004) I can't see any cases where it is actually needed. */
3224 deliver_host_address = host_address;
3225 rc = match_check_list(
3226 listptr, /* the list */
3227 0, /* separator character */
3228 &hostlist_anchor, /* anchor pointer */
3229 &local_cache_bits, /* cache pointer */
3230 check_host, /* function for testing */
3231 &cb, /* argument for function */
3232 MCL_HOST, /* type of check */
3233 (host_address == sender_host_address)?
3234 US"host" : host_address, /* text for debugging */
3235 valueptr); /* where to pass back data */
3236 deliver_host_address = save_host_address;
3243 /*************************************************
3244 * Check the given host item matches a list *
3245 *************************************************/
3247 verify_check_given_host(const uschar **listptr, const host_item *host)
3249 return verify_check_this_host(listptr, NULL, host->name, host->address, NULL);
3252 /*************************************************
3253 * Check the remote host matches a list *
3254 *************************************************/
3256 /* This is a front end to verify_check_this_host(), created because checking
3257 the remote host is a common occurrence. With luck, a good compiler will spot
3258 the tail recursion and optimize it. If there's no host address, this is
3259 command-line SMTP input - check against an empty string for the address.
3262 listptr pointer to the host list
3264 Returns: the yield of verify_check_this_host(),
3265 i.e. OK, FAIL, or DEFER
3269 verify_check_host(uschar **listptr)
3271 return verify_check_this_host(CUSS listptr, sender_host_cache, NULL,
3272 sender_host_address ? sender_host_address : US"", NULL);
3279 /*************************************************
3280 * Invert an IP address *
3281 *************************************************/
3283 /* Originally just used for DNS xBL lists, now also used for the
3284 reverse_ip expansion operator.
3287 buffer where to put the answer
3288 address the address to invert
3292 invert_address(uschar *buffer, uschar *address)
3295 uschar *bptr = buffer;
3297 /* If this is an IPv4 address mapped into IPv6 format, adjust the pointer
3298 to the IPv4 part only. */
3300 if (Ustrncmp(address, "::ffff:", 7) == 0) address += 7;
3302 /* Handle IPv4 address: when HAVE_IPV6 is false, the result of host_aton() is
3305 if (host_aton(address, bin) == 1)
3308 for (int i = 0; i < 4; i++)
3310 sprintf(CS bptr, "%d.", x & 255);
3311 while (*bptr) bptr++;
3316 /* Handle IPv6 address. Actually, as far as I know, there are no IPv6 addresses
3317 in any DNS black lists, and the format in which they will be looked up is
3318 unknown. This is just a guess. */
3322 for (int j = 3; j >= 0; j--)
3325 for (int i = 0; i < 8; i++)
3327 sprintf(CS bptr, "%x.", x & 15);
3328 while (*bptr) bptr++;
3334 /* Remove trailing period -- this is needed so that both arbitrary
3335 dnsbl keydomains and inverted addresses may be combined with the
3336 same format string, "%s.%s" */
3343 /*************************************************
3344 * Perform a single dnsbl lookup *
3345 *************************************************/
3347 /* This function is called from verify_check_dnsbl() below. It is also called
3348 recursively from within itself when domain and domain_txt are different
3349 pointers, in order to get the TXT record from the alternate domain.
3352 domain the outer dnsbl domain
3353 domain_txt alternate domain to lookup TXT record on success; when the
3354 same domain is to be used, domain_txt == domain (that is,
3355 the pointers must be identical, not just the text)
3356 keydomain the current keydomain (for debug message)
3357 prepend subdomain to lookup (like keydomain, but
3358 reversed if IP address)
3359 iplist the list of matching IP addresses, or NULL for "any"
3360 bitmask true if bitmask matching is wanted
3361 match_type condition for 'succeed' result
3362 0 => Any RR in iplist (=)
3363 1 => No RR in iplist (!=)
3364 2 => All RRs in iplist (==)
3365 3 => Some RRs not in iplist (!==)
3366 the two bits are defined as MT_NOT and MT_ALL
3367 defer_return what to return for a defer
3369 Returns: OK if lookup succeeded
3374 one_check_dnsbl(uschar *domain, uschar *domain_txt, uschar *keydomain,
3375 uschar *prepend, uschar *iplist, BOOL bitmask, int match_type,
3378 dns_answer * dnsa = store_get_dns_answer();
3381 dnsbl_cache_block *cb;
3382 int old_pool = store_pool;
3383 uschar query[256]; /* DNS domain max length */
3385 /* Construct the specific query domainname */
3387 if (!string_format(query, sizeof(query), "%s.%s", prepend, domain))
3389 log_write(0, LOG_MAIN|LOG_PANIC, "dnslist query is too long "
3390 "(ignored): %s...", query);
3394 /* Look for this query in the cache. */
3396 if ( (t = tree_search(dnsbl_cache, query))
3397 && (cb = t->data.ptr)->expiry > time(NULL)
3400 /* Previous lookup was cached */
3403 HDEBUG(D_dnsbl) debug_printf("dnslists: using result of previous lookup\n");
3406 /* If not cached from a previous lookup, we must do a DNS lookup, and
3407 cache the result in permanent memory. */
3411 uint ttl = 3600; /* max TTL for positive cache entries */
3413 store_pool = POOL_PERM;
3417 HDEBUG(D_dnsbl) debug_printf("cached data found but past valid time; ");
3421 { /* Set up a tree entry to cache the lookup */
3422 t = store_get(sizeof(tree_node) + Ustrlen(query), is_tainted(query));
3423 Ustrcpy(t->name, query);
3424 t->data.ptr = cb = store_get(sizeof(dnsbl_cache_block), FALSE);
3425 (void)tree_insertnode(&dnsbl_cache, t);
3428 /* Do the DNS lookup . */
3430 HDEBUG(D_dnsbl) debug_printf("new DNS lookup for %s\n", query);
3431 cb->rc = dns_basic_lookup(dnsa, query, T_A);
3432 cb->text_set = FALSE;
3436 /* If the lookup succeeded, cache the RHS address. The code allows for
3437 more than one address - this was for complete generality and the possible
3438 use of A6 records. However, A6 records are no longer supported. Leave the code
3441 Quite apart from one A6 RR generating multiple addresses, there are DNS
3442 lists that return more than one A record, so we must handle multiple
3443 addresses generated in that way as well.
3445 Mark the cache entry with the "now" plus the minimum of the address TTLs,
3446 or the RFC 2308 negative-cache value from the SOA if none were found. */
3452 dns_address ** addrp = &cb->rhs;
3454 for (dns_record * rr = dns_next_rr(dnsa, &dnss, RESET_ANSWERS); rr;
3455 rr = dns_next_rr(dnsa, &dnss, RESET_NEXT))
3456 if (rr->type == T_A && (da = dns_address_from_rr(dnsa, rr)))
3459 while (da->next) da = da->next;
3461 if (ttl > rr->ttl) ttl = rr->ttl;
3466 cb->expiry = time(NULL) + ttl;
3470 /* If we didn't find any A records, change the return code. This can
3471 happen when there is a CNAME record but there are no A records for what
3474 cb->rc = DNS_NODATA;
3481 /* Although there already is a neg-cache layer maintained by
3482 dns_basic_lookup(), we have a dnslist cache entry allocated and
3483 tree-inserted. So we may as well use it. */
3485 time_t soa_negttl = dns_expire_from_soa(dnsa, T_A);
3486 cb->expiry = soa_negttl ? soa_negttl : time(NULL) + ttl;
3491 cb->expiry = time(NULL) + ttl;
3495 store_pool = old_pool;
3496 HDEBUG(D_dnsbl) debug_printf("dnslists: wrote cache entry, ttl=%d\n",
3497 (int)(cb->expiry - time(NULL)));
3500 /* We now have the result of the DNS lookup, either newly done, or cached
3501 from a previous call. If the lookup succeeded, check against the address
3502 list if there is one. This may be a positive equality list (introduced by
3503 "="), a negative equality list (introduced by "!="), a positive bitmask
3504 list (introduced by "&"), or a negative bitmask list (introduced by "!&").*/
3506 if (cb->rc == DNS_SUCCEED)
3508 dns_address * da = NULL;
3509 uschar *addlist = cb->rhs->address;
3511 /* For A and AAAA records, there may be multiple addresses from multiple
3512 records. For A6 records (currently not expected to be used) there may be
3513 multiple addresses from a single record. */
3515 for (da = cb->rhs->next; da; da = da->next)
3516 addlist = string_sprintf("%s, %s", addlist, da->address);
3518 HDEBUG(D_dnsbl) debug_printf("DNS lookup for %s succeeded (yielding %s)\n",
3521 /* Address list check; this can be either for equality, or via a bitmask.
3522 In the latter case, all the bits must match. */
3526 for (da = cb->rhs; da; da = da->next)
3530 const uschar *ptr = iplist;
3533 /* Handle exact matching */
3537 while ((res = string_nextinlist(&ptr, &ipsep, ip, sizeof(ip))))
3538 if (Ustrcmp(CS da->address, ip) == 0)
3542 /* Handle bitmask matching */
3549 /* At present, all known DNS blocking lists use A records, with
3550 IPv4 addresses on the RHS encoding the information they return. I
3551 wonder if this will linger on as the last vestige of IPv4 when IPv6
3552 is ubiquitous? Anyway, for now we use paranoia code to completely
3553 ignore IPv6 addresses. The default mask is 0, which always matches.
3554 We change this only for IPv4 addresses in the list. */
3556 if (host_aton(da->address, address) == 1) mask = address[0];
3558 /* Scan the returned addresses, skipping any that are IPv6 */
3560 while ((res = string_nextinlist(&ptr, &ipsep, ip, sizeof(ip))))
3562 if (host_aton(ip, address) != 1) continue;
3563 if ((address[0] & mask) == address[0]) break;
3569 (a) An IP address in an any ('=') list matched, or
3570 (b) No IP address in an all ('==') list matched
3572 then we're done searching. */
3574 if (((match_type & MT_ALL) != 0) == (res == NULL)) break;
3577 /* If da == NULL, either
3579 (a) No IP address in an any ('=') list matched, or
3580 (b) An IP address in an all ('==') list didn't match
3582 so behave as if the DNSBL lookup had not succeeded, i.e. the host is not on
3585 if ((match_type == MT_NOT || match_type == MT_ALL) != (da == NULL))
3593 res = US"was no match"; break;
3595 res = US"was an exclude match"; break;
3597 res = US"was an IP address that did not match"; break;
3599 res = US"were no IP addresses that did not match"; break;
3601 debug_printf("=> but we are not accepting this block class because\n");
3602 debug_printf("=> there %s for %s%c%s\n",
3604 ((match_type & MT_ALL) == 0)? "" : "=",
3605 bitmask? '&' : '=', iplist);
3611 /* Either there was no IP list, or the record matched, implying that the
3612 domain is on the list. We now want to find a corresponding TXT record. If an
3613 alternate domain is specified for the TXT record, call this function
3614 recursively to look that up; this has the side effect of re-checking that
3615 there is indeed an A record at the alternate domain. */
3617 if (domain_txt != domain)
3618 return one_check_dnsbl(domain_txt, domain_txt, keydomain, prepend, NULL,
3619 FALSE, match_type, defer_return);
3621 /* If there is no alternate domain, look up a TXT record in the main domain
3622 if it has not previously been cached. */
3626 cb->text_set = TRUE;
3627 if (dns_basic_lookup(dnsa, query, T_TXT) == DNS_SUCCEED)
3628 for (dns_record * rr = dns_next_rr(dnsa, &dnss, RESET_ANSWERS); rr;
3629 rr = dns_next_rr(dnsa, &dnss, RESET_NEXT))
3630 if (rr->type == T_TXT)
3632 int len = (rr->data)[0];
3633 if (len > 511) len = 127;
3634 store_pool = POOL_PERM;
3635 cb->text = string_sprintf("%.*s", len, CUS (rr->data+1));
3636 store_pool = old_pool;
3641 dnslist_value = addlist;
3642 dnslist_text = cb->text;
3646 /* There was a problem with the DNS lookup */
3648 if (cb->rc != DNS_NOMATCH && cb->rc != DNS_NODATA)
3650 log_write(L_dnslist_defer, LOG_MAIN,
3651 "DNS list lookup defer (probably timeout) for %s: %s", query,
3652 (defer_return == OK)? US"assumed in list" :
3653 (defer_return == FAIL)? US"assumed not in list" :
3654 US"returned DEFER");
3655 return defer_return;
3658 /* No entry was found in the DNS; continue for next domain */
3662 debug_printf("DNS lookup for %s failed\n", query);
3663 debug_printf("=> that means %s is not listed at %s\n",
3673 /*************************************************
3674 * Check host against DNS black lists *
3675 *************************************************/
3677 /* This function runs checks against a list of DNS black lists, until one
3678 matches. Each item on the list can be of the form
3680 domain=ip-address/key
3682 The domain is the right-most domain that is used for the query, for example,
3683 blackholes.mail-abuse.org. If the IP address is present, there is a match only
3684 if the DNS lookup returns a matching IP address. Several addresses may be
3685 given, comma-separated, for example: x.y.z=127.0.0.1,127.0.0.2.
3687 If no key is given, what is looked up in the domain is the inverted IP address
3688 of the current client host. If a key is given, it is used to construct the
3689 domain for the lookup. For example:
3691 dsn.rfc-ignorant.org/$sender_address_domain
3693 After finding a match in the DNS, the domain is placed in $dnslist_domain, and
3694 then we check for a TXT record for an error message, and if found, save its
3695 value in $dnslist_text. We also cache everything in a tree, to optimize
3698 The TXT record is normally looked up in the same domain as the A record, but
3699 when many lists are combined in a single DNS domain, this will not be a very
3700 specific message. It is possible to specify a different domain for looking up
3701 TXT records; this is given before the main domain, comma-separated. For
3704 dnslists = http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
3705 socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3
3707 The caching ensures that only one lookup in dnsbl.sorbs.net is done.
3709 Note: an address for testing RBL is 192.203.178.39
3710 Note: an address for testing DUL is 192.203.178.4
3711 Note: a domain for testing RFCI is example.tld.dsn.rfc-ignorant.org
3715 listptr the domain/address/data list
3716 log_msgptr log message on error
3718 Returns: OK successful lookup (i.e. the address is on the list), or
3719 lookup deferred after +include_unknown
3720 FAIL name not found, or no data found for the given type, or
3721 lookup deferred after +exclude_unknown (default)
3722 DEFER lookup failure, if +defer_unknown was set
3726 verify_check_dnsbl(int where, const uschar ** listptr, uschar ** log_msgptr)
3729 int defer_return = FAIL;
3730 const uschar *list = *listptr;
3732 uschar buffer[1024];
3733 uschar revadd[128]; /* Long enough for IPv6 address */
3735 /* Indicate that the inverted IP address is not yet set up */
3739 /* In case this is the first time the DNS resolver is being used. */
3741 dns_init(FALSE, FALSE, FALSE); /*XXX dnssec? */
3743 /* Loop through all the domains supplied, until something matches */
3745 while ((domain = string_nextinlist(&list, &sep, buffer, sizeof(buffer))))
3748 BOOL bitmask = FALSE;
3755 HDEBUG(D_dnsbl) debug_printf("dnslists check: %s\n", domain);
3757 /* Deal with special values that change the behaviour on defer */
3759 if (domain[0] == '+')
3761 if (strcmpic(domain, US"+include_unknown") == 0) defer_return = OK;
3762 else if (strcmpic(domain, US"+exclude_unknown") == 0) defer_return = FAIL;
3763 else if (strcmpic(domain, US"+defer_unknown") == 0) defer_return = DEFER;
3765 log_write(0, LOG_MAIN|LOG_PANIC, "unknown item in dnslist (ignored): %s",
3770 /* See if there's explicit data to be looked up */
3772 if ((key = Ustrchr(domain, '/'))) *key++ = 0;
3774 /* See if there's a list of addresses supplied after the domain name. This is
3775 introduced by an = or a & character; if preceded by = we require all matches
3776 and if preceded by ! we invert the result. */
3778 if (!(iplist = Ustrchr(domain, '=')))
3781 iplist = Ustrchr(domain, '&');
3784 if (iplist) /* Found either = or & */
3786 if (iplist > domain && iplist[-1] == '!') /* Handle preceding ! */
3788 match_type |= MT_NOT;
3792 *iplist++ = 0; /* Terminate domain, move on */
3794 /* If we found = (bitmask == FALSE), check for == or =& */
3796 if (!bitmask && (*iplist == '=' || *iplist == '&'))
3798 bitmask = *iplist++ == '&';
3799 match_type |= MT_ALL;
3804 /* If there is a comma in the domain, it indicates that a second domain for
3805 looking up TXT records is provided, before the main domain. Otherwise we must
3806 set domain_txt == domain. */
3808 domain_txt = domain;
3809 if ((comma = Ustrchr(domain, ',')))
3815 /* Check that what we have left is a sensible domain name. There is no reason
3816 why these domains should in fact use the same syntax as hosts and email
3817 domains, but in practice they seem to. However, there is little point in
3818 actually causing an error here, because that would no doubt hold up incoming
3819 mail. Instead, I'll just log it. */
3821 for (uschar * s = domain; *s; s++)
3822 if (!isalnum(*s) && *s != '-' && *s != '.' && *s != '_')
3824 log_write(0, LOG_MAIN, "dnslists domain \"%s\" contains "
3825 "strange characters - is this right?", domain);
3829 /* Check the alternate domain if present */
3831 if (domain_txt != domain) for (uschar * s = domain_txt; *s; s++)
3832 if (!isalnum(*s) && *s != '-' && *s != '.' && *s != '_')
3834 log_write(0, LOG_MAIN, "dnslists domain \"%s\" contains "
3835 "strange characters - is this right?", domain_txt);
3839 /* If there is no key string, construct the query by adding the domain name
3840 onto the inverted host address, and perform a single DNS lookup. */
3844 if (where == ACL_WHERE_NOTSMTP_START || where == ACL_WHERE_NOTSMTP)
3846 *log_msgptr = string_sprintf
3847 ("cannot test auto-keyed dnslists condition in %s ACL",
3848 acl_wherenames[where]);
3851 if (!sender_host_address) return FAIL; /* can never match */
3852 if (revadd[0] == 0) invert_address(revadd, sender_host_address);
3853 rc = one_check_dnsbl(domain, domain_txt, sender_host_address, revadd,
3854 iplist, bitmask, match_type, defer_return);
3857 dnslist_domain = string_copy(domain_txt);
3858 dnslist_matched = string_copy(sender_host_address);
3859 HDEBUG(D_dnsbl) debug_printf("=> that means %s is listed at %s\n",
3860 sender_host_address, dnslist_domain);
3862 if (rc != FAIL) return rc; /* OK or DEFER */
3865 /* If there is a key string, it can be a list of domains or IP addresses to
3866 be concatenated with the main domain. */
3873 uschar keyrevadd[128];
3875 while ((keydomain = string_nextinlist(CUSS &key, &keysep, NULL, 0)))
3877 uschar *prepend = keydomain;
3879 if (string_is_ip_address(keydomain, NULL) != 0)
3881 invert_address(keyrevadd, keydomain);
3882 prepend = keyrevadd;
3885 rc = one_check_dnsbl(domain, domain_txt, keydomain, prepend, iplist,
3886 bitmask, match_type, defer_return);
3889 dnslist_domain = string_copy(domain_txt);
3890 dnslist_matched = string_copy(keydomain);
3891 HDEBUG(D_dnsbl) debug_printf("=> that means %s is listed at %s\n",
3892 keydomain, dnslist_domain);
3896 /* If the lookup deferred, remember this fact. We keep trying the rest
3897 of the list to see if we get a useful result, and if we don't, we return
3898 DEFER at the end. */
3900 if (rc == DEFER) defer = TRUE;
3901 } /* continue with next keystring domain/address */
3903 if (defer) return DEFER;
3905 } /* continue with next dnsdb outer domain */
3912 /* End of verify.c */