1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2022 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-only */
10 /* Functions concerned with verifying things. The original code for callout
11 caching was contributed by Kevin Fleming (but I hacked it around a bit). */
15 #include "transports/smtp.h"
17 #define CUTTHROUGH_CMD_TIMEOUT 30 /* timeout for cutthrough-routing calls */
18 #define CUTTHROUGH_DATA_TIMEOUT 60 /* timeout for cutthrough-routing calls */
19 static smtp_context ctctx;
20 uschar ctbuffer[8192];
23 static uschar cutthrough_response(client_conn_ctx *, char, uschar **, int);
27 /*************************************************
28 * Retrieve a callout cache record *
29 *************************************************/
31 /* If a record exists, check whether it has expired.
34 dbm_file an open hints file
36 type "address" or "domain"
37 positive_expire expire time for positive records
38 negative_expire expire time for negative records
40 Returns: the cache record if a non-expired one exists, else NULL
43 static dbdata_callout_cache *
44 get_callout_cache_record(open_db *dbm_file, const uschar *key, uschar *type,
45 int positive_expire, int negative_expire)
50 dbdata_callout_cache *cache_record;
52 if (!(cache_record = dbfn_read_with_length(dbm_file, key, &length)))
54 HDEBUG(D_verify) debug_printf_indent("callout cache: no %s record found for %s\n", type, key);
58 /* We treat a record as "negative" if its result field is not positive, or if
59 it is a domain record and the postmaster field is negative. */
61 negative = cache_record->result != ccache_accept ||
62 (type[0] == 'd' && cache_record->postmaster_result == ccache_reject);
63 expire = negative? negative_expire : positive_expire;
66 if (now - cache_record->time_stamp > expire)
68 HDEBUG(D_verify) debug_printf_indent("callout cache: %s record expired for %s\n", type, key);
72 /* If this is a non-reject domain record, check for the obsolete format version
73 that doesn't have the postmaster and random timestamps, by looking at the
74 length. If so, copy it to a new-style block, replicating the record's
75 timestamp. Then check the additional timestamps. (There's no point wasting
76 effort if connections are rejected.) */
78 if (type[0] == 'd' && cache_record->result != ccache_reject)
80 if (length == sizeof(dbdata_callout_cache_obs))
82 dbdata_callout_cache * new = store_get(sizeof(dbdata_callout_cache), GET_UNTAINTED);
83 memcpy(new, cache_record, length);
84 new->postmaster_stamp = new->random_stamp = new->time_stamp;
88 if (now - cache_record->postmaster_stamp > expire)
89 cache_record->postmaster_result = ccache_unknown;
91 if (now - cache_record->random_stamp > expire)
92 cache_record->random_result = ccache_unknown;
95 HDEBUG(D_verify) debug_printf_indent("callout cache: found %s record for %s\n", type, key);
101 /* Check the callout cache.
102 Options * pm_mailfrom may be modified by cache partial results.
104 Return: TRUE if result found
108 cached_callout_lookup(address_item * addr, uschar * address_key,
109 uschar * from_address, int * opt_ptr, uschar ** pm_ptr,
110 int * yield, uschar ** failure_ptr,
111 dbdata_callout_cache * new_domain_record, int * old_domain_res)
113 int options = *opt_ptr;
115 open_db *dbm_file = NULL;
117 /* Open the callout cache database, if it exists, for reading only at this
118 stage, unless caching has been disabled. */
120 if (options & vopt_callout_no_cache)
122 HDEBUG(D_verify) debug_printf_indent("callout cache: disabled by no_cache\n");
124 else if (!(dbm_file = dbfn_open(US"callout", O_RDWR, &dbblock, FALSE, TRUE)))
126 HDEBUG(D_verify) debug_printf_indent("callout cache: not available\n");
130 /* If a cache database is available see if we can avoid the need to do an
131 actual callout by making use of previously-obtained data. */
133 dbdata_callout_cache_address * cache_address_record;
134 dbdata_callout_cache * cache_record = get_callout_cache_record(dbm_file,
135 addr->domain, US"domain",
136 callout_cache_domain_positive_expire, callout_cache_domain_negative_expire);
138 /* If an unexpired cache record was found for this domain, see if the callout
139 process can be short-circuited. */
143 /* In most cases, if an early command (up to and including MAIL FROM:<>)
144 was rejected, there is no point carrying on. The callout fails. However, if
145 we are doing a recipient verification with use_sender or use_postmaster
146 set, a previous failure of MAIL FROM:<> doesn't count, because this time we
147 will be using a non-empty sender. We have to remember this situation so as
148 not to disturb the cached domain value if this whole verification succeeds
149 (we don't want it turning into "accept"). */
151 *old_domain_res = cache_record->result;
153 if ( cache_record->result == ccache_reject
154 || *from_address == 0 && cache_record->result == ccache_reject_mfnull)
157 debug_printf_indent("callout cache: domain gave initial rejection, or "
158 "does not accept HELO or MAIL FROM:<>\n");
159 setflag(addr, af_verify_nsfail);
160 addr->user_message = US"(result of an earlier callout reused).";
162 *failure_ptr = US"mail";
163 dbfn_close(dbm_file);
167 /* If a previous check on a "random" local part was accepted, we assume
168 that the server does not do any checking on local parts. There is therefore
169 no point in doing the callout, because it will always be successful. If a
170 random check previously failed, arrange not to do it again, but preserve
171 the data in the new record. If a random check is required but hasn't been
172 done, skip the remaining cache processing. */
174 if (options & vopt_callout_random) switch(cache_record->random_result)
178 debug_printf_indent("callout cache: domain accepts random addresses\n");
179 *failure_ptr = US"random";
180 dbfn_close(dbm_file);
181 return TRUE; /* Default yield is OK */
185 debug_printf_indent("callout cache: domain rejects random addresses\n");
186 *opt_ptr = options & ~vopt_callout_random;
187 new_domain_record->random_result = ccache_reject;
188 new_domain_record->random_stamp = cache_record->random_stamp;
193 debug_printf_indent("callout cache: need to check random address handling "
194 "(not cached or cache expired)\n");
195 dbfn_close(dbm_file);
199 /* If a postmaster check is requested, but there was a previous failure,
200 there is again no point in carrying on. If a postmaster check is required,
201 but has not been done before, we are going to have to do a callout, so skip
202 remaining cache processing. */
206 if (cache_record->postmaster_result == ccache_reject)
208 setflag(addr, af_verify_pmfail);
210 debug_printf_indent("callout cache: domain does not accept "
211 "RCPT TO:<postmaster@domain>\n");
213 *failure_ptr = US"postmaster";
214 setflag(addr, af_verify_pmfail);
215 addr->user_message = US"(result of earlier verification reused).";
216 dbfn_close(dbm_file);
219 if (cache_record->postmaster_result == ccache_unknown)
222 debug_printf_indent("callout cache: need to check RCPT "
223 "TO:<postmaster@domain> (not cached or cache expired)\n");
224 dbfn_close(dbm_file);
228 /* If cache says OK, set pm_mailfrom NULL to prevent a redundant
229 postmaster check if the address itself has to be checked. Also ensure
230 that the value in the cache record is preserved (with its old timestamp).
233 HDEBUG(D_verify) debug_printf_indent("callout cache: domain accepts RCPT "
234 "TO:<postmaster@domain>\n");
236 new_domain_record->postmaster_result = ccache_accept;
237 new_domain_record->postmaster_stamp = cache_record->postmaster_stamp;
241 /* We can't give a result based on information about the domain. See if there
242 is an unexpired cache record for this specific address (combined with the
243 sender address if we are doing a recipient callout with a non-empty sender).
246 if (!(cache_address_record = (dbdata_callout_cache_address *)
247 get_callout_cache_record(dbm_file, address_key, US"address",
248 callout_cache_positive_expire, callout_cache_negative_expire)))
250 dbfn_close(dbm_file);
254 if (cache_address_record->result == ccache_accept)
257 debug_printf_indent("callout cache: address record is positive\n");
262 debug_printf_indent("callout cache: address record is negative\n");
263 addr->user_message = US"Previous (cached) callout verification failure";
264 *failure_ptr = US"recipient";
268 /* Close the cache database while we actually do the callout for real. */
270 dbfn_close(dbm_file);
277 /* Write results to callout cache
280 cache_callout_write(dbdata_callout_cache * dom_rec, const uschar * domain,
281 int done, dbdata_callout_cache_address * addr_rec, uschar * address_key)
284 open_db *dbm_file = NULL;
286 /* If we get here with done == TRUE, a successful callout happened, and yield
287 will be set OK or FAIL according to the response to the RCPT command.
288 Otherwise, we looped through the hosts but couldn't complete the business.
289 However, there may be domain-specific information to cache in both cases.
291 The value of the result field in the new_domain record is ccache_unknown if
292 there was an error before or with MAIL FROM:, and errno was not zero,
293 implying some kind of I/O error. We don't want to write the cache in that case.
294 Otherwise the value is ccache_accept, ccache_reject, or ccache_reject_mfnull. */
296 if (dom_rec->result != ccache_unknown)
297 if (!(dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE, TRUE)))
299 HDEBUG(D_verify) debug_printf_indent("callout cache: not available\n");
303 (void)dbfn_write(dbm_file, domain, dom_rec,
304 (int)sizeof(dbdata_callout_cache));
305 HDEBUG(D_verify) debug_printf_indent("wrote callout cache domain record for %s:\n"
306 " result=%d postmaster=%d random=%d\n",
309 dom_rec->postmaster_result,
310 dom_rec->random_result);
313 /* If a definite result was obtained for the callout, cache it unless caching
316 if (done && addr_rec->result != ccache_unknown)
319 dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE, TRUE);
322 HDEBUG(D_verify) debug_printf_indent("no callout cache available\n");
326 (void)dbfn_write(dbm_file, address_key, addr_rec,
327 (int)sizeof(dbdata_callout_cache_address));
328 HDEBUG(D_verify) debug_printf_indent("wrote %s callout cache address record for %s\n",
329 addr_rec->result == ccache_accept ? "positive" : "negative",
334 if (dbm_file) dbfn_close(dbm_file);
338 /* Cutthrough-multi. If the existing cached cutthrough connection matches
339 the one we would make for a subsequent recipient, use it. Send the RCPT TO
340 and check the result, nonpipelined as it may be wanted immediately for
341 recipient-verification.
343 It seems simpler to deal with this case separately from the main callout loop.
344 We will need to remember it has sent, or not, so that rcpt-acl tail code
345 can do it there for the non-rcpt-verify case. For this we keep an addresscount.
347 Return: TRUE for a definitive result for the recipient
350 cutthrough_multi(address_item * addr, host_item * host_list,
351 transport_feedback * tf, int * yield)
355 if (addr->transport == cutthrough.addr.transport)
356 for (host_item * host = host_list; host; host = host->next)
357 if (Ustrcmp(host->address, cutthrough.host.address) == 0)
360 uschar *interface = NULL; /* Outgoing interface to use; NULL => any */
363 deliver_host = host->name;
364 deliver_host_address = host->address;
365 deliver_host_port = host->port;
366 deliver_domain = addr->domain;
367 transport_name = addr->transport->name;
369 host_af = Ustrchr(host->address, ':') ? AF_INET6 : AF_INET;
371 if ( !smtp_get_interface(tf->interface, host_af, addr, &interface,
373 || !smtp_get_port(tf->port, addr, &port, US"callout")
375 log_write(0, LOG_MAIN|LOG_PANIC, "<%s>: %s", addr->address,
378 smtp_port_for_connect(host, port);
380 if ( ( interface == cutthrough.interface
382 && cutthrough.interface
383 && Ustrcmp(interface, cutthrough.interface) == 0
385 && host->port == cutthrough.host.port
388 uschar * resp = NULL;
390 /* Match! Send the RCPT TO, set done from the response */
392 smtp_write_command(&ctctx, SCMD_FLUSH, "RCPT TO:<%.1000s>\r\n",
393 transport_rcpt_address(addr,
394 addr->transport->rcpt_include_affixes)) >= 0
395 && cutthrough_response(&cutthrough.cctx, '2', &resp,
396 CUTTHROUGH_DATA_TIMEOUT) == '2';
398 /* This would go horribly wrong if a callout fail was ignored by ACL.
399 We punt by abandoning cutthrough on a reject, like the
404 address_item * na = store_get(sizeof(address_item), GET_UNTAINTED);
405 *na = cutthrough.addr;
406 cutthrough.addr = *addr;
407 cutthrough.addr.host_used = &cutthrough.host;
408 cutthrough.addr.next = na;
414 cancel_cutthrough_connection(TRUE, US"recipient rejected");
415 if (!resp || errno == ETIMEDOUT)
417 HDEBUG(D_verify) debug_printf("SMTP timeout\n");
422 Ustrcpy(resp, US"connection dropped");
425 string_sprintf("response to \"%s\" was: %s",
426 big_buffer, string_printing(resp));
429 string_sprintf("Callout verification failed:\n%s", resp);
431 /* Hard rejection ends the process */
433 if (resp[0] == '5') /* Address rejected */
441 break; /* host_list */
444 cancel_cutthrough_connection(TRUE, US"incompatible connection");
451 /* A rcpt callout, or cached record of one, verified the address.
452 Set $domain_data and $local_part_data to detainted versions.
455 callout_verified_rcpt(const address_item * addr)
457 address_item a = {.address = addr->address};
458 if (deliver_split_address(&a) != OK) return;
459 deliver_localpart_data = string_copy_taint(a.local_part, GET_UNTAINTED);
460 deliver_domain_data = string_copy_taint(a.domain, GET_UNTAINTED);
464 /*************************************************
465 * Do callout verification for an address *
466 *************************************************/
468 /* This function is called from verify_address() when the address has routed to
469 a host list, and a callout has been requested. Callouts are expensive; that is
470 why a cache is used to improve the efficiency.
473 addr the address that's been routed
474 host_list the list of hosts to try
475 tf the transport feedback block
477 ifstring "interface" option from transport, or NULL
478 portstring "port" option from transport, or NULL
479 protocolstring "protocol" option from transport, or NULL
480 callout the per-command callout timeout
481 callout_overall the overall callout timeout (if < 0 use 4*callout)
482 callout_connect the callout connection timeout (if < 0 use callout)
483 options the verification options - these bits are used:
484 vopt_is_recipient => this is a recipient address
485 vopt_callout_no_cache => don't use callout cache
486 vopt_callout_fullpm => if postmaster check, do full one
487 vopt_callout_random => do the "random" thing
488 vopt_callout_recipsender => use real sender for recipient
489 vopt_callout_recippmaster => use postmaster for recipient
490 vopt_callout_hold => lazy close connection
491 se_mailfrom MAIL FROM address for sender verify; NULL => ""
492 pm_mailfrom if non-NULL, do the postmaster check with this sender
494 Returns: OK/FAIL/DEFER
498 do_callout(address_item *addr, host_item *host_list, transport_feedback *tf,
499 int callout, int callout_overall, int callout_connect, int options,
500 uschar *se_mailfrom, uschar *pm_mailfrom)
503 int old_domain_cache_result = ccache_accept;
506 uschar *from_address;
507 uschar *random_local_part = NULL;
508 const uschar *save_deliver_domain = deliver_domain;
509 uschar **failure_ptr = options & vopt_is_recipient
510 ? &recipient_verify_failure : &sender_verify_failure;
511 dbdata_callout_cache new_domain_record;
512 dbdata_callout_cache_address new_address_record;
513 time_t callout_start_time;
515 new_domain_record.result = ccache_unknown;
516 new_domain_record.postmaster_result = ccache_unknown;
517 new_domain_record.random_result = ccache_unknown;
519 memset(&new_address_record, 0, sizeof(new_address_record));
521 /* For a recipient callout, the key used for the address cache record must
522 include the sender address if we are using the real sender in the callout,
523 because that may influence the result of the callout. */
525 if (options & vopt_is_recipient)
526 if (options & vopt_callout_recipsender)
528 from_address = sender_address;
529 address_key = string_sprintf("%s/<%s>", addr->address, sender_address);
530 if (cutthrough.delivery) options |= vopt_callout_no_cache;
532 else if (options & vopt_callout_recippmaster)
534 from_address = string_sprintf("postmaster@%s", qualify_domain_sender);
535 address_key = string_sprintf("%s/<postmaster@%s>", addr->address,
536 qualify_domain_sender);
541 address_key = addr->address;
544 /* For a sender callout, we must adjust the key if the mailfrom address is not
549 from_address = se_mailfrom ? se_mailfrom : US"";
550 address_key = *from_address
551 ? string_sprintf("%s/<%s>", addr->address, from_address) : addr->address;
554 if (cached_callout_lookup(addr, address_key, from_address,
555 &options, &pm_mailfrom, &yield, failure_ptr,
556 &new_domain_record, &old_domain_cache_result))
558 cancel_cutthrough_connection(TRUE, US"cache-hit");
562 if (!addr->transport)
564 HDEBUG(D_verify) debug_printf("cannot callout via null transport\n");
567 else if (Ustrcmp(addr->transport->driver_name, "smtp") != 0)
568 log_write(0, LOG_MAIN|LOG_PANIC|LOG_CONFIG_FOR, "callout transport '%s': %s is non-smtp",
569 addr->transport->name, addr->transport->driver_name);
572 smtp_transport_options_block *ob =
573 (smtp_transport_options_block *)addr->transport->options_block;
574 smtp_context * sx = NULL;
576 /* The information wasn't available in the cache, so we have to do a real
577 callout and save the result in the cache for next time, unless no_cache is set,
578 or unless we have a previously cached negative random result. If we are to test
579 with a random local part, ensure that such a local part is available. If not,
580 log the fact, but carry on without randomising. */
582 if (options & vopt_callout_random && callout_random_local_part)
583 if (!(random_local_part = expand_string(callout_random_local_part)))
584 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand "
585 "callout_random_local_part: %s", expand_string_message);
587 /* Compile regex' used by client-side smtp */
591 /* Default the connect and overall callout timeouts if not set, and record the
592 time we are starting so that we can enforce it. */
594 if (callout_overall < 0) callout_overall = 4 * callout;
595 if (callout_connect < 0) callout_connect = callout;
596 callout_start_time = time(NULL);
598 /* Before doing a real callout, if this is an SMTP connection, flush the SMTP
599 output because a callout might take some time. When PIPELINING is active and
600 there are many recipients, the total time for doing lots of callouts can add up
601 and cause the client to time out. So in this case we forgo the PIPELINING
604 if (smtp_out && !f.disable_callout_flush) mac_smtp_fflush();
606 clearflag(addr, af_verify_pmfail); /* postmaster callout flag */
607 clearflag(addr, af_verify_nsfail); /* null sender callout flag */
609 /* cutthrough-multi: if a nonfirst rcpt has the same routing as the first,
610 and we are holding a cutthrough conn open, we can just append the rcpt to
611 that conn for verification purposes (and later delivery also). Simplest
612 coding means skipping this whole loop and doing the append separately. */
614 /* Can we re-use an open cutthrough connection? */
615 if ( cutthrough.cctx.sock >= 0
616 && (options & (vopt_callout_recipsender | vopt_callout_recippmaster))
617 == vopt_callout_recipsender
618 && !random_local_part
621 done = cutthrough_multi(addr, host_list, tf, &yield);
623 /* If we did not use a cached connection, make connections to the hosts
624 and do real callouts. The list of hosts is passed in as an argument. */
626 for (host_item * host = host_list; host && !done; host = host->next)
630 uschar * interface = NULL; /* Outgoing interface to use; NULL => any */
634 DEBUG(D_verify) debug_printf("no IP address for host name %s: skipping\n",
639 /* Check the overall callout timeout */
641 if (time(NULL) - callout_start_time >= callout_overall)
643 HDEBUG(D_verify) debug_printf("overall timeout for callout exceeded\n");
647 /* Set IPv4 or IPv6 */
649 host_af = Ustrchr(host->address, ':') ? AF_INET6 : AF_INET;
651 /* Expand and interpret the interface and port strings. The latter will not
652 be used if there is a host-specific port (e.g. from a manualroute router).
653 This has to be delayed till now, because they may expand differently for
654 different hosts. If there's a failure, log it, but carry on with the
657 deliver_host = host->name;
658 deliver_host_address = host->address;
659 deliver_host_port = host->port;
660 deliver_domain = addr->domain;
661 transport_name = addr->transport->name;
663 if ( !smtp_get_interface(tf->interface, host_af, addr, &interface,
665 || !smtp_get_port(tf->port, addr, &port, US"callout")
667 log_write(0, LOG_MAIN|LOG_PANIC, "<%s>: %s", addr->address,
670 if (!sx) sx = store_get(sizeof(*sx), GET_TAINTED); /* tainted buffers */
671 memset(sx, 0, sizeof(*sx));
673 sx->addrlist = sx->first_addr = addr;
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;
680 sx->conn_args.sock = -1;
683 tls_retry_connection:
684 /* Set the address state so that errors are recorded in it */
686 addr->transport_return = PENDING_DEFER;
687 ob->connect_timeout = callout_connect;
688 ob->command_timeout = callout;
690 /* Get the channel set up ready for a message (MAIL FROM being the next
691 SMTP command to send. If we tried TLS but it failed, try again without
694 yield = smtp_setup_conn(sx, FALSE);
697 && addr->basic_errno == ERRNO_TLSFAILURE
698 && ob->tls_tempfail_tryclear
699 && verify_check_given_host(CUSS &ob->hosts_require_tls, host) != OK
702 log_write(0, LOG_MAIN,
703 "%s: callout unencrypted to %s [%s] (not in hosts_require_tls)",
704 addr->message, host->name, host->address);
705 addr->transport_return = PENDING_DEFER;
706 yield = smtp_setup_conn(sx, TRUE);
711 errno = addr->basic_errno;
712 transport_name = NULL;
713 deliver_host = deliver_host_address = NULL;
714 deliver_domain = save_deliver_domain;
716 /* Failure to accept HELO is cached; this blocks the whole domain for all
717 senders. I/O errors and defer responses are not cached. */
719 if (yield == FAIL && (errno == 0 || errno == ERRNO_SMTPCLOSED))
721 setflag(addr, af_verify_nsfail);
722 new_domain_record.result = ccache_reject;
730 /* If we needed to authenticate, smtp_setup_conn() did that. Copy
731 the AUTH info for logging */
733 addr->authenticator = client_authenticator;
734 addr->auth_id = client_authenticated_id;
736 sx->from_addr = from_address;
737 sx->first_addr = sx->sync_addr = addr;
738 sx->ok = FALSE; /*XXX these 3 last might not be needed for verify? */
739 sx->send_rset = TRUE;
740 sx->completed_addr = FALSE;
742 new_domain_record.result = old_domain_cache_result == ccache_reject_mfnull
743 ? ccache_reject_mfnull : ccache_accept;
745 /* Do the random local part check first. Temporarily replace the recipient
746 with the "random" value */
748 if (random_local_part)
750 uschar * main_address = addr->address;
751 const uschar * rcpt_domain = addr->domain;
754 uschar * errstr = NULL;
755 if ( testflag(addr, af_utf8_downcvt)
756 && (rcpt_domain = string_domain_utf8_to_alabel(rcpt_domain,
760 addr->message = errstr;
761 errno = ERRNO_EXPANDFAIL;
762 setflag(addr, af_verify_nsfail);
764 rcpt_domain = US""; /*XXX errorhandling! */
768 /* This would be ok for 1st rcpt of a cutthrough (the case handled here;
769 subsequents are done in cutthrough_multi()), but no way to
770 handle a subsequent because of the RSET vaporising the MAIL FROM.
771 So refuse to support any. Most cutthrough use will not involve
772 random_local_part, so no loss. */
773 cancel_cutthrough_connection(TRUE, US"random-recipient");
775 addr->address = string_sprintf("%s@%.1000s",
776 random_local_part, rcpt_domain);
779 /* If accepted, we aren't going to do any further tests below.
780 Otherwise, cache a real negative response, and get back to the right
781 state to send RCPT. Unless there's some problem such as a dropped
782 connection, we expect to succeed, because the commands succeeded above.
783 However, some servers drop the connection after responding to an
784 invalid recipient, so on (any) error we drop and remake the connection.
785 XXX We don't care about that for postmaster_full. Should we?
787 XXX could we add another flag to the context, and have the common
788 code emit the RSET too? Even pipelined after the RCPT...
789 Then the main-verify call could use it if there's to be a subsequent
791 The sync_responses() would need to be taught about it and we'd
792 need another return code filtering out to here.
794 Avoid using a SIZE option on the MAIL for all random-rcpt checks.
797 sx->avoid_option = OPTION_SIZE;
799 /* Remember when we last did a random test */
800 new_domain_record.random_stamp = time(NULL);
802 if (smtp_write_mail_and_rcpt_cmds(sx, &yield) == 0)
803 switch(addr->transport_return)
805 case PENDING_OK: /* random was accepted, unfortunately */
806 new_domain_record.random_result = ccache_accept;
807 yield = OK; /* Only usable verify result we can return */
809 *failure_ptr = US"random";
811 case FAIL: /* rejected: the preferred result */
812 new_domain_record.random_result = ccache_reject;
813 sx->avoid_option = 0;
815 /* Between each check, issue RSET, because some servers accept only
816 one recipient after MAIL FROM:<>.
817 XXX We don't care about that for postmaster_full. Should we? */
820 smtp_write_command(sx, SCMD_FLUSH, "RSET\r\n") >= 0 &&
821 smtp_read_response(sx, sx->buffer, sizeof(sx->buffer), '2', callout)))
825 debug_printf_indent("problem after random/rset/mfrom; reopen conn\n");
826 random_local_part = NULL;
828 tls_close(sx->cctx.tls_ctx, TLS_SHUTDOWN_NOWAIT);
830 HDEBUG(D_transport|D_acl|D_v) debug_printf_indent(" SMTP(close)>>\n");
831 (void)close(sx->cctx.sock);
833 #ifndef DISABLE_EVENT
834 (void) event_raise(addr->transport->event_action,
835 US"tcp:close", NULL, NULL);
837 addr->address = main_address;
838 addr->transport_return = PENDING_DEFER;
839 sx->first_addr = sx->sync_addr = addr;
841 sx->send_rset = TRUE;
842 sx->completed_addr = FALSE;
843 goto tls_retry_connection;
844 case DEFER: /* 4xx response to random */
845 break; /* Just to be clear. ccache_unknown, !done. */
848 /* Re-setup for main verify, or for the error message when failing */
849 addr->address = main_address;
850 addr->transport_return = PENDING_DEFER;
851 sx->first_addr = sx->sync_addr = addr;
853 sx->send_rset = TRUE;
854 sx->completed_addr = FALSE;
859 /* Main verify. For rcpt-verify use SIZE if we know it and we're not cacheing;
860 for sndr-verify never use it. */
864 if (!(options & vopt_is_recipient && options & vopt_callout_no_cache))
865 sx->avoid_option = OPTION_SIZE;
868 switch(smtp_write_mail_and_rcpt_cmds(sx, &yield))
870 case 0: switch(addr->transport_return) /* ok so far */
872 case PENDING_OK: done = TRUE;
873 new_address_record.result = ccache_accept;
875 case FAIL: done = TRUE;
877 *failure_ptr = US"recipient";
878 new_address_record.result = ccache_reject;
884 case -1: /* MAIL response error */
885 *failure_ptr = US"mail";
886 if (errno == 0 && sx->buffer[0] == '5')
888 setflag(addr, af_verify_nsfail);
889 if (from_address[0] == 0)
890 new_domain_record.result = ccache_reject_mfnull;
893 /* non-MAIL read i/o error */
894 /* non-MAIL response timeout */
895 /* internal error; channel still usable */
896 default: break; /* transmit failed */
900 addr->auth_sndr = client_authenticated_sender;
902 deliver_host = deliver_host_address = NULL;
903 deliver_domain = save_deliver_domain;
905 /* Do postmaster check if requested; if a full check is required, we
906 check for RCPT TO:<postmaster> (no domain) in accordance with RFC 821. */
908 if (done && pm_mailfrom)
910 /* Could possibly shift before main verify, just above, and be ok
911 for cutthrough. But no way to handle a subsequent rcpt, so just
913 cancel_cutthrough_connection(TRUE, US"postmaster verify");
914 HDEBUG(D_acl|D_v) debug_printf_indent("Cutthrough cancelled by presence of postmaster verify\n");
916 done = smtp_write_command(sx, SCMD_FLUSH, "RSET\r\n") >= 0
917 && smtp_read_response(sx, sx->buffer, sizeof(sx->buffer), '2', callout);
921 uschar * main_address = addr->address;
923 /*XXX oops, affixes */
924 addr->address = string_sprintf("postmaster@%.1000s", addr->domain);
925 addr->transport_return = PENDING_DEFER;
927 sx->from_addr = pm_mailfrom;
928 sx->first_addr = sx->sync_addr = addr;
930 sx->send_rset = TRUE;
931 sx->completed_addr = FALSE;
932 sx->avoid_option = OPTION_SIZE;
934 if( smtp_write_mail_and_rcpt_cmds(sx, &yield) == 0
935 && addr->transport_return == PENDING_OK
939 done = (options & vopt_callout_fullpm) != 0
940 && smtp_write_command(sx, SCMD_FLUSH,
941 "RCPT TO:<postmaster>\r\n") >= 0
942 && smtp_read_response(sx, sx->buffer,
943 sizeof(sx->buffer), '2', callout);
945 /* Sort out the cache record */
947 new_domain_record.postmaster_stamp = time(NULL);
950 new_domain_record.postmaster_result = ccache_accept;
951 else if (errno == 0 && sx->buffer[0] == '5')
953 *failure_ptr = US"postmaster";
954 setflag(addr, af_verify_pmfail);
955 new_domain_record.postmaster_result = ccache_reject;
958 addr->address = main_address;
961 /* For any failure of the main check, other than a negative response, we just
962 close the connection and carry on. We can identify a negative response by the
963 fact that errno is zero. For I/O errors it will be non-zero
965 Set up different error texts for logging and for sending back to the caller
966 as an SMTP response. Log in all cases, using a one-line format. For sender
967 callouts, give a full response to the caller, but for recipient callouts,
968 don't give the IP address because this may be an internal host whose identity
969 is not to be widely broadcast. */
975 HDEBUG(D_verify) debug_printf("SMTP timeout\n");
976 sx->send_quit = FALSE;
982 extern int acl_where; /* src/acl.c */
984 addr->message = US"response to \"EHLO\" did not include SMTPUTF8";
985 addr->user_message = acl_where == ACL_WHERE_RCPT
986 ? US"533 no support for internationalised mailbox name"
987 : US"550 mailbox unavailable";
994 sx->send_quit = FALSE;
998 if (*sx->buffer == 0) Ustrcpy(sx->buffer, US"connection dropped");
1000 /*XXX test here is ugly; seem to have a split of responsibility for
1001 building this message. Need to rationalise. Where is it done
1002 before here, and when not?
1003 Not == 5xx resp to MAIL on main-verify
1005 if (!addr->message) addr->message =
1006 string_sprintf("response to \"%s\" was: %s",
1007 big_buffer, string_printing(sx->buffer));
1009 /* RFC 5321 section 4.2: the text portion of the response may have only
1010 HT, SP, Printable US-ASCII. Deal with awkward chars by cutting the
1011 received message off before passing it onward. Newlines are ok; they
1012 just become a multiline response (but wrapped in the error code we
1015 for (uschar * s = sx->buffer;
1016 *s && s < sx->buffer + sizeof(sx->buffer);
1020 if (c != '\t' && c != '\n' && (c < ' ' || c > '~'))
1022 if (s - sx->buffer < sizeof(sx->buffer) - 12)
1023 memcpy(s, "(truncated)", 12);
1029 addr->user_message = options & vopt_is_recipient
1030 ? string_sprintf("Callout verification failed:\n%s", sx->buffer)
1031 : string_sprintf("Called: %s\nSent: %s\nResponse: %s",
1032 host->address, big_buffer, sx->buffer);
1034 /* Hard rejection ends the process */
1036 if (sx->buffer[0] == '5') /* Address rejected */
1044 /* End the SMTP conversation and close the connection. */
1046 /* Cutthrough - on a successful connect and recipient-verify with
1047 use-sender and we are 1st rcpt and have no cutthrough conn so far
1048 here is where we want to leave the conn open. Ditto for a lazy-close
1051 if (cutthrough.delivery)
1053 if (addr->transport->filter_command)
1055 cutthrough.delivery= FALSE;
1056 HDEBUG(D_acl|D_v) debug_printf("Cutthrough cancelled by presence of transport filter\n");
1058 #ifndef DISABLE_DKIM
1059 if (ob->dkim.dkim_domain)
1061 cutthrough.delivery= FALSE;
1062 HDEBUG(D_acl|D_v) debug_printf("Cutthrough cancelled by presence of DKIM signing\n");
1065 #ifdef EXPERIMENTAL_ARC
1068 cutthrough.delivery= FALSE;
1069 HDEBUG(D_acl|D_v) debug_printf("Cutthrough cancelled by presence of ARC signing\n");
1074 if ( (cutthrough.delivery || options & vopt_callout_hold)
1078 && (options & (vopt_callout_recipsender|vopt_callout_recippmaster|vopt_success_on_redirect))
1079 == vopt_callout_recipsender
1080 && !random_local_part
1082 && cutthrough.cctx.sock < 0
1086 HDEBUG(D_acl|D_v) debug_printf_indent("holding verify callout open for %s\n",
1088 ? "cutthrough delivery" : "potential further verifies and delivery");
1090 cutthrough.callout_hold_only = !cutthrough.delivery;
1091 cutthrough.is_tls = tls_out.active.sock >= 0;
1092 /* We assume no buffer in use in the outblock */
1093 cutthrough.cctx = sx->cctx;
1094 cutthrough.nrcpt = 1;
1095 cutthrough.transport = addr->transport->name;
1096 cutthrough.interface = interface;
1097 cutthrough.snd_port = sending_port;
1098 cutthrough.peer_options = smtp_peer_options;
1099 cutthrough.host = *host;
1101 int oldpool = store_pool;
1102 store_pool = POOL_PERM;
1103 cutthrough.snd_ip = string_copy(sending_ip_address);
1104 cutthrough.host.name = string_copy(host->name);
1105 cutthrough.host.address = string_copy(host->address);
1106 store_pool = oldpool;
1109 /* Save the address_item and parent chain for later logging */
1110 cutthrough.addr = *addr;
1111 cutthrough.addr.next = NULL;
1112 cutthrough.addr.host_used = &cutthrough.host;
1113 for (address_item * caddr = &cutthrough.addr, * parent = addr->parent;
1115 caddr = caddr->parent, parent = parent->parent)
1116 *(caddr->parent = store_get(sizeof(address_item), GET_UNTAINTED)) = *parent;
1118 ctctx.outblock.buffer = ctbuffer;
1119 ctctx.outblock.buffersize = sizeof(ctbuffer);
1120 ctctx.outblock.ptr = ctbuffer;
1121 /* ctctx.outblock.cmd_count = 0; ctctx.outblock.authenticating = FALSE; */
1122 ctctx.outblock.cctx = &cutthrough.cctx;
1126 /* Ensure no cutthrough on multiple verifies that were incompatible */
1127 if (options & vopt_callout_recipsender)
1128 cancel_cutthrough_connection(TRUE, US"not usable for cutthrough");
1130 if (smtp_write_command(sx, SCMD_FLUSH, "QUIT\r\n") != -1)
1131 /* Wait a short time for response, and discard it */
1132 smtp_read_response(sx, sx->buffer, sizeof(sx->buffer), '2', 1);
1134 if (sx->cctx.sock >= 0)
1137 if (sx->cctx.tls_ctx)
1139 tls_close(sx->cctx.tls_ctx, TLS_SHUTDOWN_NOWAIT);
1140 sx->cctx.tls_ctx = NULL;
1143 HDEBUG(D_transport|D_acl|D_v) debug_printf_indent(" SMTP(close)>>\n");
1144 (void)close(sx->cctx.sock);
1146 smtp_debug_cmd_report();
1147 #ifndef DISABLE_EVENT
1148 (void) event_raise(addr->transport->event_action, US"tcp:close", NULL, NULL);
1153 if (!done || yield != OK)
1154 addr->message = string_sprintf("%s [%s] : %s", host->name, host->address,
1156 } /* Loop through all hosts, while !done */
1159 /* If we get here with done == TRUE, a successful callout happened, and yield
1160 will be set OK or FAIL according to the response to the RCPT command.
1161 Otherwise, we looped through the hosts but couldn't complete the business.
1162 However, there may be domain-specific information to cache in both cases. */
1164 if (!(options & vopt_callout_no_cache))
1165 cache_callout_write(&new_domain_record, addr->domain,
1166 done, &new_address_record, address_key);
1168 /* Failure to connect to any host, or any response other than 2xx or 5xx is a
1169 temporary error. If there was only one host, and a response was received, leave
1170 it alone if supplying details. Otherwise, give a generic response. */
1174 uschar * dullmsg = string_sprintf("Could not complete %s verify callout",
1175 options & vopt_is_recipient ? "recipient" : "sender");
1178 addr->message = host_list->next || !addr->message
1179 ? dullmsg : string_sprintf("%s: %s", dullmsg, addr->message);
1181 addr->user_message = smtp_return_error_details
1182 ? string_sprintf("%s for <%s>.\n"
1183 "The mail server(s) for the domain may be temporarily unreachable, or\n"
1184 "they may be permanently unreachable from this server. In the latter case,\n%s",
1185 dullmsg, addr->address,
1186 options & vopt_is_recipient
1187 ? "the address will never be accepted."
1188 : "you need to change the address or create an MX record for its domain\n"
1189 "if it is supposed to be generally accessible from the Internet.\n"
1190 "Talk to your mail administrator for details.")
1193 /* Force a specific error code */
1195 addr->basic_errno = ERRNO_CALLOUTDEFER;
1198 /* Come here from within the cache-reading code on fast-track exit. */
1201 tls_modify_variables(&tls_in); /* return variables to inbound values */
1207 /* Called after recipient-acl to get a cutthrough connection open when
1208 one was requested and a recipient-verify wasn't subsequently done.
1211 open_cutthrough_connection(address_item * addr)
1216 /* Use a recipient-verify-callout to set up the cutthrough connection. */
1217 /* We must use a copy of the address for verification, because it might
1221 HDEBUG(D_acl) debug_printf_indent("----------- %s cutthrough setup ------------\n",
1222 rcpt_count > 1 ? "more" : "start");
1223 rc = verify_address(&addr2, NULL,
1224 vopt_is_recipient | vopt_callout_recipsender | vopt_callout_no_cache,
1225 CUTTHROUGH_CMD_TIMEOUT, -1, -1,
1227 addr->message = addr2.message;
1228 addr->user_message = addr2.user_message;
1229 HDEBUG(D_acl) debug_printf_indent("----------- end cutthrough setup ------------\n");
1235 /* Send given number of bytes from the buffer */
1237 cutthrough_send(int n)
1239 if(cutthrough.cctx.sock < 0)
1245 ? tls_write(cutthrough.cctx.tls_ctx, ctctx.outblock.buffer, n, FALSE)
1248 send(cutthrough.cctx.sock, ctctx.outblock.buffer, n, 0) > 0
1251 transport_count += n;
1252 ctctx.outblock.ptr= ctctx.outblock.buffer;
1256 HDEBUG(D_transport|D_acl) debug_printf_indent("cutthrough_send failed: %s\n", strerror(errno));
1263 _cutthrough_puts(uschar * cp, int n)
1267 if(ctctx.outblock.ptr >= ctctx.outblock.buffer+ctctx.outblock.buffersize)
1268 if(!cutthrough_send(ctctx.outblock.buffersize))
1271 *ctctx.outblock.ptr++ = *cp++;
1276 /* Buffered output of counted data block. Return boolean success */
1278 cutthrough_puts(uschar * cp, int n)
1280 if (cutthrough.cctx.sock < 0) return TRUE;
1281 if (_cutthrough_puts(cp, n)) return TRUE;
1282 cancel_cutthrough_connection(TRUE, US"transmit failed");
1287 cutthrough_data_puts(uschar * cp, int n)
1289 if (cutthrough.delivery) (void) cutthrough_puts(cp, n);
1295 _cutthrough_flush_send(void)
1297 int n = ctctx.outblock.ptr - ctctx.outblock.buffer;
1300 if(!cutthrough_send(n))
1306 /* Send out any bufferred output. Return boolean success. */
1308 cutthrough_flush_send(void)
1310 if (_cutthrough_flush_send()) return TRUE;
1311 cancel_cutthrough_connection(TRUE, US"transmit failed");
1317 cutthrough_put_nl(void)
1319 return cutthrough_puts(US"\r\n", 2);
1324 cutthrough_data_put_nl(void)
1326 cutthrough_data_puts(US"\r\n", 2);
1330 /* Get and check response from cutthrough target */
1332 cutthrough_response(client_conn_ctx * cctx, char expect, uschar ** copy, int timeout)
1334 smtp_context sx = {0};
1335 uschar inbuffer[4096];
1336 uschar responsebuffer[4096];
1338 sx.inblock.buffer = inbuffer;
1339 sx.inblock.buffersize = sizeof(inbuffer);
1340 sx.inblock.ptr = inbuffer;
1341 sx.inblock.ptrend = inbuffer;
1342 sx.inblock.cctx = cctx;
1343 if(!smtp_read_response(&sx, responsebuffer, sizeof(responsebuffer), expect, timeout))
1344 cancel_cutthrough_connection(TRUE, US"target timeout on read");
1349 *copy = cp = string_copy(responsebuffer);
1350 /* Trim the trailing end of line */
1351 cp += Ustrlen(responsebuffer);
1352 if(cp > *copy && cp[-1] == '\n') *--cp = '\0';
1353 if(cp > *copy && cp[-1] == '\r') *--cp = '\0';
1356 return responsebuffer[0];
1360 /* Negotiate dataphase with the cutthrough target, returning success boolean */
1362 cutthrough_predata(void)
1364 if(cutthrough.cctx.sock < 0 || cutthrough.callout_hold_only)
1367 smtp_debug_cmd(US"DATA", 0);
1368 cutthrough_puts(US"DATA\r\n", 6);
1369 cutthrough_flush_send();
1371 /* Assume nothing buffered. If it was it gets ignored. */
1372 return cutthrough_response(&cutthrough.cctx, '3', NULL, CUTTHROUGH_DATA_TIMEOUT) == '3';
1376 /* tctx arg only to match write_chunk() */
1378 cutthrough_write_chunk(transport_ctx * tctx, uschar * s, int len)
1381 while(s && (s2 = Ustrchr(s, '\n')))
1383 if(!cutthrough_puts(s, s2-s) || !cutthrough_put_nl())
1391 /* Buffered send of headers. Return success boolean. */
1392 /* Expands newlines to wire format (CR,NL). */
1393 /* Also sends header-terminating blank line. */
1395 cutthrough_headers_send(void)
1399 if(cutthrough.cctx.sock < 0 || cutthrough.callout_hold_only)
1402 /* We share a routine with the mainline transport to handle header add/remove/rewrites,
1403 but having a separate buffered-output function (for now)
1405 HDEBUG(D_acl) debug_printf_indent("----------- start cutthrough headers send -----------\n");
1407 tctx.u.fd = cutthrough.cctx.sock;
1408 tctx.tblock = cutthrough.addr.transport;
1409 tctx.addr = &cutthrough.addr;
1410 tctx.check_string = US".";
1411 tctx.escape_string = US"..";
1412 /*XXX check under spool_files_wireformat. Might be irrelevant */
1413 tctx.options = topt_use_crlf;
1415 if (!transport_headers_send(&tctx, &cutthrough_write_chunk))
1418 HDEBUG(D_acl) debug_printf_indent("----------- done cutthrough headers send ------------\n");
1424 close_cutthrough_connection(const uschar * why)
1426 int fd = cutthrough.cctx.sock;
1429 /* We could be sending this after a bunch of data, but that is ok as
1430 the only way to cancel the transfer in dataphase is to drop the tcp
1431 conn before the final dot.
1433 client_conn_ctx tmp_ctx = cutthrough.cctx;
1434 ctctx.outblock.ptr = ctbuffer;
1435 smtp_debug_cmd(US"QUIT", 0);
1436 _cutthrough_puts(US"QUIT\r\n", 6); /* avoid recursion */
1437 _cutthrough_flush_send();
1438 cutthrough.cctx.sock = -1; /* avoid recursion via read timeout */
1439 cutthrough.nrcpt = 0; /* permit re-cutthrough on subsequent message */
1441 /* Wait a short time for response, and discard it */
1442 cutthrough_response(&tmp_ctx, '2', NULL, 1);
1445 if (cutthrough.is_tls)
1447 tls_close(cutthrough.cctx.tls_ctx, TLS_SHUTDOWN_NOWAIT);
1448 cutthrough.cctx.tls_ctx = NULL;
1449 cutthrough.is_tls = FALSE;
1452 HDEBUG(D_transport|D_acl|D_v) debug_printf_indent(" SMTP(close)>>\n");
1454 smtp_debug_cmd_report();
1455 HDEBUG(D_acl) debug_printf_indent("----------- cutthrough shutdown (%s) ------------\n", why);
1457 ctctx.outblock.ptr = ctbuffer;
1461 cancel_cutthrough_connection(BOOL close_noncutthrough_verifies, const uschar * why)
1463 if (cutthrough.delivery || close_noncutthrough_verifies)
1464 close_cutthrough_connection(why);
1465 cutthrough.delivery = cutthrough.callout_hold_only = FALSE;
1470 release_cutthrough_connection(const uschar * why)
1472 if (cutthrough.cctx.sock < 0) return;
1473 HDEBUG(D_acl) debug_printf_indent("release cutthrough conn: %s\n", why);
1474 cutthrough.cctx.sock = -1;
1475 cutthrough.cctx.tls_ctx = NULL;
1476 cutthrough.delivery = cutthrough.callout_hold_only = FALSE;
1482 /* Have senders final-dot. Send one to cutthrough target, and grab the response.
1483 Log an OK response as a transmission.
1484 Close the connection.
1485 Return smtp response-class digit.
1488 cutthrough_finaldot(void)
1491 HDEBUG(D_transport|D_acl|D_v) debug_printf_indent(" SMTP>> .\n");
1493 /* Assume data finshed with new-line */
1494 if( !cutthrough_puts(US".", 1)
1495 || !cutthrough_put_nl()
1496 || !cutthrough_flush_send()
1498 return cutthrough.addr.message;
1500 res = cutthrough_response(&cutthrough.cctx, '2', &cutthrough.addr.message,
1501 CUTTHROUGH_DATA_TIMEOUT);
1502 for (address_item * addr = &cutthrough.addr; addr; addr = addr->next)
1504 addr->message = cutthrough.addr.message;
1508 delivery_log(LOG_MAIN, addr, (int)'>', NULL);
1509 close_cutthrough_connection(US"delivered");
1513 delivery_log(LOG_MAIN, addr, 0,
1514 US"tmp-reject from cutthrough after DATA:");
1518 delivery_log(LOG_MAIN|LOG_REJECT, addr, 0,
1519 US"rejected after DATA:");
1526 return cutthrough.addr.message;
1531 /*************************************************
1532 * Copy error to toplevel address *
1533 *************************************************/
1535 /* This function is used when a verify fails or defers, to ensure that the
1536 failure or defer information is in the original toplevel address. This applies
1537 when an address is redirected to a single new address, and the failure or
1538 deferral happens to the child address.
1541 vaddr the verify address item
1542 addr the final address item
1545 Returns: the value of YIELD
1549 copy_error(address_item *vaddr, address_item *addr, int yield)
1553 vaddr->message = addr->message;
1554 vaddr->user_message = addr->user_message;
1555 vaddr->basic_errno = addr->basic_errno;
1556 vaddr->more_errno = addr->more_errno;
1557 vaddr->prop.address_data = addr->prop.address_data;
1558 vaddr->prop.variables = NULL;
1559 tree_dup((tree_node **)&vaddr->prop.variables, addr->prop.variables);
1560 copyflag(vaddr, addr, af_pass_message);
1568 /**************************************************
1569 * printf that automatically handles TLS if needed *
1570 ***************************************************/
1572 /* This function is used by verify_address() as a substitute for all fprintf()
1573 calls; a direct fprintf() will not produce output in a TLS SMTP session, such
1574 as a response to an EXPN command. smtp_in.c makes smtp_printf available but
1575 that assumes that we always use the smtp_out FILE* when not using TLS or the
1576 ssl buffer when we are. Instead we take a FILE* parameter and check to see if
1577 that is smtp_out; if so, smtp_printf() with TLS support, otherwise regular
1581 f the candidate FILE* to write to
1582 format format string
1583 ... optional arguments
1589 static void PRINTF_FUNCTION(2,3)
1590 respond_printf(FILE *f, const char *format, ...)
1594 va_start(ap, format);
1595 if (smtp_out && (f == smtp_out))
1596 smtp_vprintf(format, FALSE, ap);
1598 vfprintf(f, format, ap);
1604 /*************************************************
1605 * Verify an email address *
1606 *************************************************/
1608 /* This function is used both for verification (-bv and at other times) and
1609 address testing (-bt), which is indicated by address_test_mode being set.
1612 vaddr contains the address to verify; the next field in this block
1614 fp if not NULL, write the result to this file
1615 options various option bits:
1616 vopt_fake_sender => this sender verify is not for the real
1617 sender (it was verify=sender=xxxx or an address from a
1618 header line) - rewriting must not change sender_address
1619 vopt_is_recipient => this is a recipient address, otherwise
1620 it's a sender address - this affects qualification and
1621 rewriting and messages from callouts
1622 vopt_qualify => qualify an unqualified address; else error
1623 vopt_expn => called from SMTP EXPN command
1624 vopt_success_on_redirect => when a new address is generated
1625 the verification instantly succeeds
1627 These ones are used by do_callout() -- the options variable
1630 vopt_callout_fullpm => if postmaster check, do full one
1631 vopt_callout_no_cache => don't use callout cache
1632 vopt_callout_random => do the "random" thing
1633 vopt_callout_recipsender => use real sender for recipient
1634 vopt_callout_recippmaster => use postmaster for recipient
1636 callout if > 0, specifies that callout is required, and gives timeout
1637 for individual commands
1638 callout_overall if > 0, gives overall timeout for the callout function;
1639 if < 0, a default is used (see do_callout())
1640 callout_connect the connection timeout for callouts
1641 se_mailfrom when callout is requested to verify a sender, use this
1642 in MAIL FROM; NULL => ""
1643 pm_mailfrom when callout is requested, if non-NULL, do the postmaster
1644 thing and use this as the sender address (may be "")
1646 routed if not NULL, set TRUE if routing succeeded, so we can
1647 distinguish between routing failed and callout failed
1649 Returns: OK address verified
1650 FAIL address failed to verify
1651 DEFER can't tell at present
1655 verify_address(address_item * vaddr, FILE * fp, int options, int callout,
1656 int callout_overall, int callout_connect, uschar * se_mailfrom,
1657 uschar *pm_mailfrom, BOOL *routed)
1660 BOOL full_info = fp ? debug_selector != 0 : FALSE;
1661 BOOL expn = (options & vopt_expn) != 0;
1662 BOOL success_on_redirect = (options & vopt_success_on_redirect) != 0;
1665 int verify_type = expn ? v_expn :
1666 f.address_test_mode ? v_none :
1667 options & vopt_is_recipient ? v_recipient : v_sender;
1668 address_item *addr_list;
1669 address_item *addr_new = NULL;
1670 address_item *addr_remote = NULL;
1671 address_item *addr_local = NULL;
1672 address_item *addr_succeed = NULL;
1673 uschar **failure_ptr = options & vopt_is_recipient
1674 ? &recipient_verify_failure : &sender_verify_failure;
1675 uschar *ko_prefix, *cr;
1676 uschar *address = vaddr->address;
1677 uschar *save_sender;
1678 uschar null_sender[] = { 0 }; /* Ensure writeable memory */
1680 /* Clear, just in case */
1682 *failure_ptr = NULL;
1684 /* Set up a prefix and suffix for error message which allow us to use the same
1685 output statements both in EXPN mode (where an SMTP response is needed) and when
1686 debugging with an output file. */
1690 ko_prefix = US"553 ";
1693 else ko_prefix = cr = US"";
1695 /* Add qualify domain if permitted; otherwise an unqualified address fails. */
1697 if (parse_find_at(address) == NULL)
1699 if (!(options & vopt_qualify))
1702 respond_printf(fp, "%sA domain is required for \"%s\"%s\n",
1703 ko_prefix, address, cr);
1704 *failure_ptr = US"qualify";
1707 /* deconst ok as address was not const */
1708 address = US rewrite_address_qualify(address, options & vopt_is_recipient);
1713 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
1714 debug_printf("%s %s\n", f.address_test_mode? "Testing" : "Verifying", address);
1717 /* Rewrite and report on it. Clear the domain and local part caches - these
1718 may have been set by domains and local part tests during an ACL. */
1720 if (global_rewrite_rules)
1722 uschar *old = address;
1723 /* deconst ok as address was not const */
1724 address = US rewrite_address(address, options & vopt_is_recipient, FALSE,
1725 global_rewrite_rules, rewrite_existflags);
1728 for (int i = 0; i < (MAX_NAMED_LIST * 2)/32; i++) vaddr->localpart_cache[i] = 0;
1729 for (int i = 0; i < (MAX_NAMED_LIST * 2)/32; i++) vaddr->domain_cache[i] = 0;
1730 if (fp && !expn) fprintf(fp, "Address rewritten as: %s\n", address);
1734 /* If this is the real sender address, we must update sender_address at
1735 this point, because it may be referred to in the routers. */
1737 if (!(options & (vopt_fake_sender|vopt_is_recipient)))
1738 sender_address = address;
1740 /* If the address was rewritten to <> no verification can be done, and we have
1741 to return OK. This rewriting is permitted only for sender addresses; for other
1742 addresses, such rewriting fails. */
1744 if (!address[0]) return OK;
1746 /* Flip the legacy TLS-related variables over to the outbound set in case
1747 they're used in the context of a transport used by verification. Reset them
1748 at exit from this routine (so no returns allowed from here on). */
1750 tls_modify_variables(&tls_out);
1752 /* Save a copy of the sender address for re-instating if we change it to <>
1753 while verifying a sender address (a nice bit of self-reference there). */
1755 save_sender = sender_address;
1757 /* Observability variable for router/transport use */
1759 verify_mode = options & vopt_is_recipient ? US"R" : US"S";
1761 /* Update the address structure with the possibly qualified and rewritten
1762 address. Set it up as the starting address on the chain of new addresses. */
1764 vaddr->address = address;
1767 /* We need a loop, because an address can generate new addresses. We must also
1768 cope with generated pipes and files at the top level. (See also the code and
1769 comment in deliver.c.) However, it is usually the case that the router for
1770 user's .forward files has its verify flag turned off.
1772 If an address generates more than one child, the loop is used only when
1773 full_info is set, and this can only be set locally. Remote enquiries just get
1774 information about the top level address, not anything that it generated. */
1779 address_item *addr = addr_new;
1781 addr_new = addr->next;
1786 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
1787 debug_printf("Considering %s\n", addr->address);
1790 /* Handle generated pipe, file or reply addresses. We don't get these
1791 when handling EXPN, as it does only one level of expansion. */
1793 if (testflag(addr, af_pfr))
1800 if (addr->address[0] == '>')
1802 allow = testflag(addr, af_allow_reply);
1803 fprintf(fp, "%s -> mail %s", addr->parent->address, addr->address + 1);
1807 allow = addr->address[0] == '|'
1808 ? testflag(addr, af_allow_pipe) : testflag(addr, af_allow_file);
1809 fprintf(fp, "%s -> %s", addr->parent->address, addr->address);
1812 if (addr->basic_errno == ERRNO_BADTRANSPORT)
1813 fprintf(fp, "\n*** Error in setting up pipe, file, or autoreply:\n"
1814 "%s\n", addr->message);
1816 fprintf(fp, "\n transport = %s\n", addr->transport->name);
1818 fprintf(fp, " *** forbidden ***\n");
1823 /* Just in case some router parameter refers to it. */
1825 return_path = addr->prop.errors_address
1826 ? addr->prop.errors_address : sender_address;
1828 /* Split the address into domain and local part, handling the %-hack if
1829 necessary, and then route it. While routing a sender address, set
1830 $sender_address to <> because that is what it will be if we were trying to
1831 send a bounce to the sender. */
1833 if (routed) *routed = FALSE;
1834 if ((rc = deliver_split_address(addr)) == OK)
1836 if (!(options & vopt_is_recipient)) sender_address = null_sender;
1837 rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
1838 &addr_succeed, verify_type);
1839 sender_address = save_sender; /* Put back the real sender */
1842 /* If routing an address succeeded, set the flag that remembers, for use when
1843 an ACL cached a sender verify (in case a callout fails). Then if routing set
1844 up a list of hosts or the transport has a host list, and the callout option
1845 is set, and we aren't in a host checking run, do the callout verification,
1846 and set another flag that notes that a callout happened. */
1850 BOOL local_verify = FALSE;
1852 if (routed) *routed = TRUE;
1855 transport_instance * tp;
1856 host_item * host_list = addr->host_list;
1858 /* Make up some data for use in the case where there is no remote
1861 transport_feedback tf = {
1862 .interface = NULL, /* interface (=> any) */
1864 .protocol = US"smtp",
1866 .helo_data = US"$smtp_active_hostname",
1867 .hosts_override = FALSE,
1868 .hosts_randomize = FALSE,
1869 .gethostbyname = FALSE,
1870 .qualify_single = TRUE,
1871 .search_parents = FALSE
1874 /* If verification yielded a remote transport, we want to use that
1875 transport's options, so as to mimic what would happen if we were really
1876 sending a message to this address. */
1878 if ((tp = addr->transport))
1879 if (!tp->info->local)
1881 (void)(tp->setup)(tp, addr, &tf, 0, 0, NULL);
1883 /* If the transport has hosts and the router does not, or if the
1884 transport is configured to override the router's hosts, we must build a
1885 host list of the transport's hosts, and find the IP addresses */
1887 if (tf.hosts && (!host_list || tf.hosts_override))
1890 const uschar *save_deliver_domain = deliver_domain;
1891 uschar *save_deliver_localpart = deliver_localpart;
1893 host_list = NULL; /* Ignore the router's hosts */
1895 deliver_domain = addr->domain;
1896 deliver_localpart = addr->local_part;
1897 s = expand_string(tf.hosts);
1898 deliver_domain = save_deliver_domain;
1899 deliver_localpart = save_deliver_localpart;
1903 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand list of hosts "
1904 "\"%s\" in %s transport for callout: %s", tf.hosts,
1905 tp->name, expand_string_message);
1910 host_build_hostlist(&host_list, s, tf.hosts_randomize);
1912 /* Just ignore failures to find a host address. If we don't manage
1913 to find any addresses, the callout will defer. Note that more than
1914 one address may be found for a single host, which will result in
1915 additional host items being inserted into the chain. Hence we must
1916 save the next host first. */
1918 flags = HOST_FIND_BY_A | HOST_FIND_BY_AAAA;
1919 if (tf.qualify_single) flags |= HOST_FIND_QUALIFY_SINGLE;
1920 if (tf.search_parents) flags |= HOST_FIND_SEARCH_PARENTS;
1922 for (host_item * host = host_list, * nexthost; host; host = nexthost)
1924 nexthost = host->next;
1925 if (tf.gethostbyname ||
1926 string_is_ip_address(host->name, NULL) != 0)
1927 (void)host_find_byname(host, NULL, flags, NULL, TRUE);
1930 const dnssec_domains * dsp = NULL;
1931 if (Ustrcmp(tp->driver_name, "smtp") == 0)
1933 smtp_transport_options_block * ob =
1934 (smtp_transport_options_block *) tp->options_block;
1938 (void) host_find_bydns(host, NULL, flags, NULL, NULL, NULL,
1945 else if ( options & vopt_quota
1946 && Ustrcmp(tp->driver_name, "appendfile") == 0)
1947 local_verify = TRUE;
1949 /* Can only do a callout if we have at least one host! If the callout
1950 fails, it will have set ${sender,recipient}_verify_failure. */
1954 HDEBUG(D_verify) debug_printf("Attempting full verification using callout\n");
1955 if (host_checking && !f.host_checking_callout)
1958 debug_printf("... callout omitted by default when host testing\n"
1959 "(Use -bhc if you want the callouts to happen.)\n");
1964 deliver_set_expansions(addr);
1966 rc = do_callout(addr, host_list, &tf, callout, callout_overall,
1967 callout_connect, options, se_mailfrom, pm_mailfrom);
1969 deliver_set_expansions(NULL);
1971 if ( options & vopt_is_recipient
1973 /* set to "random", with OK, for an accepted random */
1974 && !recipient_verify_failure
1976 callout_verified_rcpt(addr);
1979 else if (local_verify)
1981 HDEBUG(D_verify) debug_printf("Attempting quota verification\n");
1983 deliver_set_expansions(addr);
1984 deliver_local(addr, TRUE);
1985 rc = addr->transport_return;
1988 HDEBUG(D_verify) debug_printf("Cannot do callout: neither router nor "
1989 "transport provided a host list, or transport is not smtp\n");
1993 /* Otherwise, any failure is a routing failure */
1995 else *failure_ptr = US"route";
1997 /* A router may return REROUTED if it has set up a child address as a result
1998 of a change of domain name (typically from widening). In this case we always
1999 want to continue to verify the new child. */
2001 if (rc == REROUTED) continue;
2003 /* Handle hard failures */
2010 address_item *p = addr->parent;
2012 respond_printf(fp, "%s%s %s", ko_prefix,
2013 full_info ? addr->address : address,
2014 f.address_test_mode ? "is undeliverable" : "failed to verify");
2015 if (!expn && f.admin_user)
2017 if (addr->basic_errno > 0)
2018 respond_printf(fp, ": %s", strerror(addr->basic_errno));
2020 respond_printf(fp, ": %s", addr->message);
2023 /* Show parents iff doing full info */
2025 if (full_info) while (p)
2027 respond_printf(fp, "%s\n <-- %s", cr, p->address);
2030 respond_printf(fp, "%s\n", cr);
2032 cancel_cutthrough_connection(TRUE, US"routing hard fail");
2036 yield = copy_error(vaddr, addr, FAIL);
2044 else if (rc == DEFER)
2049 address_item *p = addr->parent;
2050 respond_printf(fp, "%s%s cannot be resolved at this time", ko_prefix,
2051 full_info? addr->address : address);
2052 if (!expn && f.admin_user)
2054 if (addr->basic_errno > 0)
2055 respond_printf(fp, ": %s", strerror(addr->basic_errno));
2057 respond_printf(fp, ": %s", addr->message);
2058 else if (addr->basic_errno <= 0)
2059 respond_printf(fp, ": unknown error");
2062 /* Show parents iff doing full info */
2064 if (full_info) while (p)
2066 respond_printf(fp, "%s\n <-- %s", cr, p->address);
2069 respond_printf(fp, "%s\n", cr);
2071 cancel_cutthrough_connection(TRUE, US"routing soft fail");
2075 yield = copy_error(vaddr, addr, DEFER);
2078 if (yield == OK) yield = DEFER;
2081 /* If we are handling EXPN, we do not want to continue to route beyond
2082 the top level (whose address is in "address"). */
2086 uschar *ok_prefix = US"250-";
2089 if (!addr_local && !addr_remote)
2090 respond_printf(fp, "250 mail to <%s> is discarded\r\n", address);
2092 respond_printf(fp, "250 <%s>\r\n", address);
2096 address_item *addr2 = addr_new;
2097 addr_new = addr2->next;
2098 if (!addr_new) ok_prefix = US"250 ";
2099 respond_printf(fp, "%s<%s>\r\n", ok_prefix, addr2->address);
2105 /* Successful routing other than EXPN. */
2109 /* Handle successful routing when short info wanted. Otherwise continue for
2110 other (generated) addresses. Short info is the operational case. Full info
2111 can be requested only when debug_selector != 0 and a file is supplied.
2113 There is a conflict between the use of aliasing as an alternate email
2114 address, and as a sort of mailing list. If an alias turns the incoming
2115 address into just one address (e.g. J.Caesar->jc44) you may well want to
2116 carry on verifying the generated address to ensure it is valid when
2117 checking incoming mail. If aliasing generates multiple addresses, you
2118 probably don't want to do this. Exim therefore treats the generation of
2119 just a single new address as a special case, and continues on to verify the
2120 generated address. */
2122 if ( !full_info /* Stop if short info wanted AND */
2123 && ( ( !addr_new /* No new address OR */
2124 || addr_new->next /* More than one new address OR */
2125 || testflag(addr_new, af_pfr) /* New address is pfr */
2128 ( addr_new /* At least one new address AND */
2129 && success_on_redirect /* success_on_redirect is set */
2133 if (fp) fprintf(fp, "%s %s\n",
2134 address, f.address_test_mode ? "is deliverable" : "verified");
2136 /* If we have carried on to verify a child address, we want the value
2137 of $address_data to be that of the child */
2139 vaddr->prop.address_data = addr->prop.address_data;
2140 vaddr->prop.variables = NULL;
2141 tree_dup((tree_node **)&vaddr->prop.variables, addr->prop.variables);
2143 /* If stopped because more than one new address, cannot cutthrough */
2145 if (addr_new && addr_new->next)
2146 cancel_cutthrough_connection(TRUE, US"multiple addresses from routing");
2152 } /* Loop for generated addresses */
2154 /* Display the full results of the successful routing, including any generated
2155 addresses. Control gets here only when full_info is set, which requires fp not
2156 to be NULL, and this occurs only when a top-level verify is called with the
2157 debugging switch on.
2159 If there are no local and no remote addresses, and there were no pipes, files,
2160 or autoreplies, and there were no errors or deferments, the message is to be
2161 discarded, usually because of the use of :blackhole: in an alias file. */
2163 if (allok && !addr_local && !addr_remote)
2165 fprintf(fp, "mail to %s is discarded\n", address);
2169 for (addr_list = addr_local, i = 0; i < 2; addr_list = addr_remote, i++)
2172 address_item *addr = addr_list;
2173 transport_instance * tp = addr->transport;
2175 addr_list = addr->next;
2177 fprintf(fp, "%s", CS addr->address);
2179 /* If the address is a duplicate, show something about it. */
2181 if (!testflag(addr, af_pfr))
2184 if ((tnode = tree_search(tree_duplicates, addr->unique)))
2185 fprintf(fp, " [duplicate, would not be delivered]");
2186 else tree_add_duplicate(addr->unique, addr);
2189 /* Now show its parents */
2191 for (address_item * p = addr->parent; p; p = p->parent)
2192 fprintf(fp, "\n <-- %s", p->address);
2195 /* Show router, and transport */
2197 fprintf(fp, "router = %s, transport = %s\n",
2198 addr->router->name, tp ? tp->name : US"unset");
2200 /* Show any hosts that are set up by a router unless the transport
2201 is going to override them; fiddle a bit to get a nice format. */
2203 if (addr->host_list && tp && !tp->overrides_hosts)
2207 for (host_item * h = addr->host_list; h; h = h->next)
2208 { /* get max lengths of host names, addrs */
2209 int len = Ustrlen(h->name);
2210 if (len > maxlen) maxlen = len;
2211 len = h->address ? Ustrlen(h->address) : 7;
2212 if (len > maxaddlen) maxaddlen = len;
2214 for (host_item * h = addr->host_list; h; h = h->next)
2216 fprintf(fp, " host %-*s ", maxlen, h->name);
2219 fprintf(fp, "[%s%-*c", h->address, maxaddlen+1 - Ustrlen(h->address), ']');
2220 else if (tp->info->local)
2221 fprintf(fp, " %-*s ", maxaddlen, ""); /* Omit [unknown] for local */
2223 fprintf(fp, "[%s%-*c", "unknown", maxaddlen+1 - 7, ']');
2225 if (h->mx >= 0) fprintf(fp, " MX=%d", h->mx);
2226 if (h->port != PORT_NONE) fprintf(fp, " port=%d", h->port);
2227 if (f.running_in_test_harness && h->dnssec == DS_YES) fputs(" AD", fp);
2228 if (h->status == hstatus_unusable) fputs(" ** unusable **", fp);
2234 /* Yield will be DEFER or FAIL if any one address has, only for full_info (which is
2235 the -bv or -bt case). */
2239 tls_modify_variables(&tls_in); /* return variables to inbound values */
2247 /*************************************************
2248 * Check headers for syntax errors *
2249 *************************************************/
2251 /* This function checks those header lines that contain addresses, and verifies
2252 that all the addresses therein are 5322-syntactially correct.
2255 msgptr where to put an error message
2262 verify_check_headers(uschar **msgptr)
2267 for (header_line * h = header_list; h && yield == OK; h = h->next)
2269 if (h->type != htype_from &&
2270 h->type != htype_reply_to &&
2271 h->type != htype_sender &&
2272 h->type != htype_to &&
2273 h->type != htype_cc &&
2274 h->type != htype_bcc)
2277 colon = Ustrchr(h->text, ':');
2279 Uskip_whitespace(&s);
2281 /* Loop for multiple addresses in the header, enabling group syntax. Note
2282 that we have to reset this after the header has been scanned. */
2284 f.parse_allow_group = TRUE;
2288 uschar *ss = parse_find_address_end(s, FALSE);
2289 uschar *recipient, *errmess;
2290 int terminator = *ss;
2291 int start, end, domain;
2293 /* Temporarily terminate the string at this point, and extract the
2294 operative address within, allowing group syntax. */
2297 recipient = parse_extract_address(s,&errmess,&start,&end,&domain,FALSE);
2300 /* Permit an unqualified address only if the message is local, or if the
2301 sending host is configured to be permitted to send them. */
2303 if (recipient && !domain)
2305 if (h->type == htype_from || h->type == htype_sender)
2307 if (!f.allow_unqualified_sender) recipient = NULL;
2311 if (!f.allow_unqualified_recipient) recipient = NULL;
2313 if (!recipient) errmess = US"unqualified address not permitted";
2316 /* It's an error if no address could be extracted, except for the special
2317 case of an empty address. */
2319 if (!recipient && Ustrcmp(errmess, "empty address") != 0)
2321 uschar *verb = US"is";
2326 /* Arrange not to include any white space at the end in the
2327 error message or the header name. */
2329 while (t > s && isspace(t[-1])) t--;
2330 while (tt > h->text && isspace(tt[-1])) tt--;
2332 /* Add the address that failed to the error message, since in a
2333 header with very many addresses it is sometimes hard to spot
2334 which one is at fault. However, limit the amount of address to
2335 quote - cases have been seen where, for example, a missing double
2336 quote in a humungous To: header creates an "address" that is longer
2337 than string_sprintf can handle. */
2346 /* deconst cast ok as we're passing a non-const to string_printing() */
2347 *msgptr = US string_printing(
2348 string_sprintf("%s: failing address in \"%.*s:\" header %s: %.*s",
2349 errmess, (int)(tt - h->text), h->text, verb, len, s));
2352 break; /* Out of address loop */
2355 /* Advance to the next address */
2357 s = ss + (terminator ? 1 : 0);
2358 Uskip_whitespace(&s);
2359 } /* Next address */
2361 f.parse_allow_group = FALSE;
2362 f.parse_found_group = FALSE;
2363 } /* Next header unless yield has been set FALSE */
2369 /*************************************************
2370 * Check header names for 8-bit characters *
2371 *************************************************/
2373 /* This function checks for invalid characters in header names. See
2374 RFC 5322, 2.2. and RFC 6532, 3.
2377 msgptr where to put an error message
2384 verify_check_header_names_ascii(uschar **msgptr)
2388 for (header_line * h = header_list; h; h = h->next)
2390 colon = Ustrchr(h->text, ':');
2391 for(uschar * s = h->text; s < colon; s++)
2392 if ((*s < 33) || (*s > 126))
2394 *msgptr = string_sprintf("Invalid character in header \"%.*s\" found",
2395 (int)(colon - h->text), h->text);
2402 /*************************************************
2403 * Check for blind recipients *
2404 *************************************************/
2406 /* This function checks that every (envelope) recipient is mentioned in either
2407 the To: or Cc: header lines, thus detecting blind carbon copies.
2409 There are two ways of scanning that could be used: either scan the header lines
2410 and tick off the recipients, or scan the recipients and check the header lines.
2411 The original proposed patch did the former, but I have chosen to do the latter,
2412 because (a) it requires no memory and (b) will use fewer resources when there
2413 are many addresses in To: and/or Cc: and only one or two envelope recipients.
2415 Arguments: case_sensitive true if case sensitive matching should be used
2416 Returns: OK if there are no blind recipients
2417 FAIL if there is at least one blind recipient
2421 verify_check_notblind(BOOL case_sensitive)
2423 for (int i = 0; i < recipients_count; i++)
2426 uschar *address = recipients_list[i].address;
2428 for (header_line * h = header_list; !found && h; h = h->next)
2432 if (h->type != htype_to && h->type != htype_cc) continue;
2434 colon = Ustrchr(h->text, ':');
2436 Uskip_whitespace(&s);
2438 /* Loop for multiple addresses in the header, enabling group syntax. Note
2439 that we have to reset this after the header has been scanned. */
2441 f.parse_allow_group = TRUE;
2445 uschar * ss = parse_find_address_end(s, FALSE);
2446 uschar * recipient, * errmess;
2447 int terminator = *ss;
2448 int start, end, domain;
2450 /* Temporarily terminate the string at this point, and extract the
2451 operative address within, allowing group syntax. */
2454 recipient = parse_extract_address(s,&errmess,&start,&end,&domain,FALSE);
2457 /* If we found a valid recipient that has a domain, compare it with the
2458 envelope recipient. Local parts are compared with case-sensitivity
2459 according to the routine arg, domains case-insensitively.
2460 By comparing from the start with length "domain", we include the "@" at
2461 the end, which ensures that we are comparing the whole local part of each
2464 if (recipient && domain != 0)
2465 if ((found = (case_sensitive
2466 ? Ustrncmp(recipient, address, domain) == 0
2467 : strncmpic(recipient, address, domain) == 0)
2468 && strcmpic(recipient + domain, address + domain) == 0))
2471 /* Advance to the next address */
2473 s = ss + (terminator ? 1:0);
2474 Uskip_whitespace(&s);
2475 } /* Next address */
2477 f.parse_allow_group = FALSE;
2478 f.parse_found_group = FALSE;
2479 } /* Next header (if found is false) */
2481 if (!found) return FAIL;
2482 } /* Next recipient */
2489 /*************************************************
2490 * Find if verified sender *
2491 *************************************************/
2493 /* Usually, just a single address is verified as the sender of the message.
2494 However, Exim can be made to verify other addresses as well (often related in
2495 some way), and this is useful in some environments. There may therefore be a
2496 chain of such addresses that have previously been tested. This function finds
2497 whether a given address is on the chain.
2499 Arguments: the address to be verified
2500 Returns: pointer to an address item, or NULL
2504 verify_checked_sender(uschar *sender)
2506 for (address_item * addr = sender_verified_list; addr; addr = addr->next)
2507 if (Ustrcmp(sender, addr->address) == 0) return addr;
2515 /*************************************************
2516 * Get valid header address *
2517 *************************************************/
2519 /* Scan the originator headers of the message, looking for an address that
2520 verifies successfully. RFC 822 says:
2522 o The "Sender" field mailbox should be sent notices of
2523 any problems in transport or delivery of the original
2524 messages. If there is no "Sender" field, then the
2525 "From" field mailbox should be used.
2527 o If the "Reply-To" field exists, then the reply should
2528 go to the addresses indicated in that field and not to
2529 the address(es) indicated in the "From" field.
2531 So we check a Sender field if there is one, else a Reply_to field, else a From
2532 field. As some strange messages may have more than one of these fields,
2533 especially if they are resent- fields, check all of them if there is more than
2537 user_msgptr points to where to put a user error message
2538 log_msgptr points to where to put a log error message
2539 callout timeout for callout check (passed to verify_address())
2540 callout_overall overall callout timeout (ditto)
2541 callout_connect connect callout timeout (ditto)
2542 se_mailfrom mailfrom for verify; NULL => ""
2543 pm_mailfrom sender for pm callout check (passed to verify_address())
2544 options callout options (passed to verify_address())
2545 verrno where to put the address basic_errno
2547 If log_msgptr is set to something without setting user_msgptr, the caller
2548 normally uses log_msgptr for both things.
2550 Returns: result of the verification attempt: OK, FAIL, or DEFER;
2551 FAIL is given if no appropriate headers are found
2555 verify_check_header_address(uschar **user_msgptr, uschar **log_msgptr,
2556 int callout, int callout_overall, int callout_connect, uschar *se_mailfrom,
2557 uschar *pm_mailfrom, int options, int *verrno)
2559 static int header_types[] = { htype_sender, htype_reply_to, htype_from };
2563 for (int i = 0; i < 3 && !done; i++)
2564 for (header_line * h = header_list; h != NULL && !done; h = h->next)
2566 int terminator, new_ok;
2567 uschar *s, *ss, *endname;
2569 if (h->type != header_types[i]) continue;
2570 s = endname = Ustrchr(h->text, ':') + 1;
2572 /* Scan the addresses in the header, enabling group syntax. Note that we
2573 have to reset this after the header has been scanned. */
2575 f.parse_allow_group = TRUE;
2579 address_item *vaddr;
2581 while (isspace(*s) || *s == ',') s++;
2582 if (*s == 0) break; /* End of header */
2584 ss = parse_find_address_end(s, FALSE);
2586 /* The terminator is a comma or end of header, but there may be white
2587 space preceding it (including newline for the last address). Move back
2588 past any white space so we can check against any cached envelope sender
2589 address verifications. */
2591 while (isspace(ss[-1])) ss--;
2595 HDEBUG(D_verify) debug_printf("verifying %.*s header address %s\n",
2596 (int)(endname - h->text), h->text, s);
2598 /* See if we have already verified this address as an envelope sender,
2599 and if so, use the previous answer. */
2601 vaddr = verify_checked_sender(s);
2603 if (vaddr != NULL && /* Previously checked */
2604 (callout <= 0 || /* No callout needed; OR */
2605 vaddr->special_action > 256)) /* Callout was done */
2607 new_ok = vaddr->special_action & 255;
2608 HDEBUG(D_verify) debug_printf("previously checked as envelope sender\n");
2609 *ss = terminator; /* Restore shortened string */
2612 /* Otherwise we run the verification now. We must restore the shortened
2613 string before running the verification, so the headers are correct, in
2614 case there is any rewriting. */
2618 int start, end, domain;
2619 uschar *address = parse_extract_address(s, log_msgptr, &start, &end,
2624 /* If we found an empty address, just carry on with the next one, but
2625 kill the message. */
2627 if (!address && Ustrcmp(*log_msgptr, "empty address") == 0)
2634 /* If verification failed because of a syntax error, fail this
2635 function, and ensure that the failing address gets added to the error
2641 while (ss > s && isspace(ss[-1])) ss--;
2642 *log_msgptr = string_sprintf("syntax error in '%.*s' header when "
2643 "scanning for sender: %s in \"%.*s\"",
2644 (int)(endname - h->text), h->text, *log_msgptr, (int)(ss - s), s);
2650 /* Else go ahead with the sender verification. But it isn't *the*
2651 sender of the message, so set vopt_fake_sender to stop sender_address
2652 being replaced after rewriting or qualification. */
2656 vaddr = deliver_make_addr(address, FALSE);
2657 new_ok = verify_address(vaddr, NULL, options | vopt_fake_sender,
2658 callout, callout_overall, callout_connect, se_mailfrom,
2663 /* We now have the result, either newly found, or cached. If we are
2664 giving out error details, set a specific user error. This means that the
2665 last of these will be returned to the user if all three fail. We do not
2666 set a log message - the generic one below will be used. */
2670 *verrno = vaddr->basic_errno;
2671 if (smtp_return_error_details)
2672 *user_msgptr = string_sprintf("Rejected after DATA: "
2673 "could not verify \"%.*s\" header address\n%s: %s",
2674 (int)(endname - h->text), h->text, vaddr->address, vaddr->message);
2677 /* Success or defer */
2686 if (new_ok == DEFER) yield = DEFER;
2688 /* Move on to any more addresses in the header */
2691 } /* Next address */
2693 f.parse_allow_group = FALSE;
2694 f.parse_found_group = FALSE;
2695 } /* Next header, unless done */
2696 /* Next header type unless done */
2698 if (yield == FAIL && *log_msgptr == NULL)
2699 *log_msgptr = US"there is no valid sender in any header line";
2701 if (yield == DEFER && *log_msgptr == NULL)
2702 *log_msgptr = US"all attempts to verify a sender in a header line deferred";
2710 /*************************************************
2711 * Get RFC 1413 identification *
2712 *************************************************/
2714 /* Attempt to get an id from the sending machine via the RFC 1413 protocol. If
2715 the timeout is set to zero, then the query is not done. There may also be lists
2716 of hosts and nets which are exempt. To guard against malefactors sending
2717 non-printing characters which could, for example, disrupt a message's headers,
2718 make sure the string consists of printing characters only.
2721 port the port to connect to; usually this is IDENT_PORT (113), but when
2722 running in the test harness with -bh a different value is used.
2726 Side effect: any received ident value is put in sender_ident (NULL otherwise)
2730 verify_get_ident(int port)
2732 client_conn_ctx ident_conn_ctx = {0};
2734 int received_sender_port, received_interface_port, n;
2737 uschar buffer[2048];
2739 /* Default is no ident. Check whether we want to do an ident check for this
2742 sender_ident = NULL;
2743 if (rfc1413_query_timeout <= 0 || verify_check_host(&rfc1413_hosts) != OK)
2746 DEBUG(D_ident) debug_printf("doing ident callback\n");
2748 /* Set up a connection to the ident port of the remote host. Bind the local end
2749 to the incoming interface address. If the sender host address is an IPv6
2750 address, the incoming interface address will also be IPv6. */
2752 host_af = Ustrchr(sender_host_address, ':') == NULL ? AF_INET : AF_INET6;
2753 if ((ident_conn_ctx.sock = ip_socket(SOCK_STREAM, host_af)) < 0) return;
2755 if (ip_bind(ident_conn_ctx.sock, host_af, interface_address, 0) < 0)
2757 DEBUG(D_ident) debug_printf("bind socket for ident failed: %s\n",
2762 /* Construct and send the query. */
2764 qlen = snprintf(CS buffer, sizeof(buffer), "%d , %d\r\n",
2765 sender_host_port, interface_port);
2766 early_data.data = buffer;
2767 early_data.len = qlen;
2769 /*XXX we trust that the query is idempotent */
2770 if (ip_connect(ident_conn_ctx.sock, host_af, sender_host_address, port,
2771 rfc1413_query_timeout, &early_data) < 0)
2773 if (errno == ETIMEDOUT && LOGGING(ident_timeout))
2774 log_write(0, LOG_MAIN, "ident connection to %s timed out",
2775 sender_host_address);
2777 DEBUG(D_ident) debug_printf("ident connection to %s failed: %s\n",
2778 sender_host_address, strerror(errno));
2782 /* Read a response line. We put it into the rest of the buffer, using several
2783 recv() calls if necessary. */
2791 int size = sizeof(buffer) - (p - buffer);
2793 if (size <= 0) goto END_OFF; /* Buffer filled without seeing \n. */
2794 count = ip_recv(&ident_conn_ctx, p, size, time(NULL) + rfc1413_query_timeout);
2795 if (count <= 0) goto END_OFF; /* Read error or EOF */
2797 /* Scan what we just read, to see if we have reached the terminating \r\n. Be
2798 generous, and accept a plain \n terminator as well. The only illegal
2801 for (pp = p; pp < p + count; pp++)
2803 if (*pp == 0) goto END_OFF; /* Zero octet not allowed */
2806 if (pp[-1] == '\r') pp--;
2808 goto GOT_DATA; /* Break out of both loops */
2812 /* Reached the end of the data without finding \n. Let the loop continue to
2813 read some more, if there is room. */
2820 /* We have received a line of data. Check it carefully. It must start with the
2821 same two port numbers that we sent, followed by data as defined by the RFC. For
2824 12345 , 25 : USERID : UNIX :root
2826 However, the amount of white space may be different to what we sent. In the
2827 "osname" field there may be several sub-fields, comma separated. The data we
2828 actually want to save follows the third colon. Some systems put leading spaces
2829 in it - we discard those. */
2831 if (sscanf(CS buffer + qlen, "%d , %d%n", &received_sender_port,
2832 &received_interface_port, &n) != 2 ||
2833 received_sender_port != sender_host_port ||
2834 received_interface_port != interface_port)
2837 p = buffer + qlen + n;
2838 while(isspace(*p)) p++;
2839 if (*p++ != ':') goto END_OFF;
2840 while(isspace(*p)) p++;
2841 if (Ustrncmp(p, "USERID", 6) != 0) goto END_OFF;
2843 while(isspace(*p)) p++;
2844 if (*p++ != ':') goto END_OFF;
2845 while (*p != 0 && *p != ':') p++;
2846 if (*p++ == 0) goto END_OFF;
2847 while(isspace(*p)) p++;
2848 if (*p == 0) goto END_OFF;
2850 /* The rest of the line is the data we want. We turn it into printing
2851 characters when we save it, so that it cannot mess up the format of any logging
2852 or Received: lines into which it gets inserted. We keep a maximum of 127
2853 characters. The deconst cast is ok as we fed a nonconst to string_printing() */
2855 sender_ident = US string_printing(string_copyn(p, 127));
2856 DEBUG(D_ident) debug_printf("sender_ident = %s\n", sender_ident);
2859 (void)close(ident_conn_ctx.sock);
2866 /*************************************************
2867 * Match host to a single host-list item *
2868 *************************************************/
2870 /* This function compares a host (name or address) against a single item
2871 from a host list. The host name gets looked up if it is needed and is not
2872 already known. The function is called from verify_check_this_host() via
2873 match_check_list(), which is why most of its arguments are in a single block.
2876 arg the argument block (see below)
2877 ss the host-list item
2878 valueptr where to pass back looked up data, or NULL
2879 error for error message when returning ERROR
2882 host_name (a) the host name, or
2883 (b) NULL, implying use sender_host_name and
2884 sender_host_aliases, looking them up if required, or
2885 (c) the empty string, meaning that only IP address matches
2887 host_address the host address
2888 host_ipv4 the IPv4 address taken from an IPv6 one
2892 DEFER lookup deferred
2893 ERROR (a) failed to find the host name or IP address, or
2894 (b) unknown lookup type specified, or
2895 (c) host name encountered when only IP addresses are
2900 check_host(void * arg, const uschar * ss, const uschar ** valueptr, uschar ** error)
2902 check_host_block * cb = (check_host_block *)arg;
2905 BOOL iplookup = FALSE, isquery = FALSE;
2906 BOOL isiponly = cb->host_name && !cb->host_name[0];
2908 uschar * semicolon, * endname, * opts;
2911 /* Optimize for the special case when the pattern is "*". */
2913 if (*ss == '*' && !ss[1]) return OK;
2915 /* If the pattern is empty, it matches only in the case when there is no host -
2916 this can occur in ACL checking for SMTP input using the -bs option. In this
2917 situation, the host address is the empty string. */
2919 if (!cb->host_address[0]) return *ss ? FAIL : OK;
2920 if (!*ss) return FAIL;
2922 /* If the pattern is precisely "@" then match against the primary host name,
2923 provided that host name matching is permitted; if it's "@[]" match against the
2924 local host's IP addresses. */
2929 if (isiponly) return ERROR;
2930 ss = primary_hostname;
2932 else if (Ustrcmp(ss, "@[]") == 0)
2934 for (ip_address_item * ip = host_find_interfaces(); ip; ip = ip->next)
2935 if (Ustrcmp(ip->address, cb->host_address) == 0) return OK;
2939 /* If the pattern is an IP address, optionally followed by a bitmask count, do
2940 a (possibly masked) comparison with the current IP address. */
2942 if (string_is_ip_address(ss, &maskoffset) != 0)
2943 return (host_is_in_net(cb->host_address, ss, maskoffset)? OK : FAIL);
2945 /* The pattern is not an IP address. A common error that people make is to omit
2946 one component of an IPv4 address, either by accident, or believing that, for
2947 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,
2948 which it isn't. (Those applications that do accept 1.2.3 as an IP address
2949 interpret it as 1.2.0.3 because the final component becomes 16-bit - this is an
2950 ancient specification.) To aid in debugging these cases, we give a specific
2951 error if the pattern contains only digits and dots or contains a slash preceded
2952 only by digits and dots (a slash at the start indicates a file name and of
2953 course slashes may be present in lookups, but not preceded only by digits and
2956 for (t = ss; isdigit(*t) || *t == '.'; ) t++;
2957 if (!*t || (*t == '/' && t != ss))
2959 *error = US"malformed IPv4 address or address mask";
2963 /* See if there is a semicolon in the pattern, separating a searchtype
2964 prefix. If there is one then check for comma-sep options. */
2966 if ((semicolon = Ustrchr(ss, ';')))
2967 if ((opts = Ustrchr(ss, ',')) && opts < semicolon)
2970 opts = string_copyn(opts, semicolon - opts);
2974 endname = semicolon;
2978 /* If we are doing an IP address only match, then all lookups must be IP
2979 address lookups, even if there is no "net-". */
2982 iplookup = semicolon != NULL;
2984 /* Otherwise, if the item is of the form net[n]-lookup;<file|query> then it is
2985 a lookup on a masked IP network, in textual form. We obey this code even if we
2986 have already set iplookup, so as to skip over the "net-" prefix and to set the
2987 mask length. The net- stuff really only applies to single-key lookups where the
2988 key is implicit. For query-style lookups the key is specified in the query.
2989 From release 4.30, the use of net- for query style is no longer needed, but we
2990 retain it for backward compatibility. */
2992 if (Ustrncmp(ss, "net", 3) == 0 && semicolon)
2995 for (t = ss + 3; isdigit(*t); t++) mlen = mlen * 10 + *t - '0';
2996 if (mlen == 0 && t == ss+3) mlen = -1; /* No mask supplied */
2997 iplookup = *t++ == '-';
3002 /* Do the IP address lookup if that is indeed what we have */
3010 uschar *filename, *key, *result;
3013 /* Find the search type */
3015 search_type = search_findtype(t, endname - t);
3017 if (search_type < 0) log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s",
3018 search_error_message);
3020 /* Adjust parameters for the type of lookup. For a query-style lookup, there
3021 is no file name, and the "key" is just the query. For query-style with a file
3022 name, we have to fish the file off the start of the query. For a single-key
3023 lookup, the key is the current IP address, masked appropriately, and
3024 reconverted to text form, with the mask appended. For IPv6 addresses, specify
3025 dot separators instead of colons, except when the lookup type is "iplsearch".
3028 if (mac_islookup(search_type, lookup_absfilequery))
3030 filename = semicolon + 1;
3032 while (*key != 0 && !isspace(*key)) key++;
3033 filename = string_copyn(filename, key - filename);
3034 while (isspace(*key)) key++;
3036 else if (mac_islookup(search_type, lookup_querystyle))
3039 key = semicolon + 1;
3041 else /* Single-key style */
3043 int sep = (Ustrcmp(lookup_list[search_type]->name, "iplsearch") == 0)?
3045 insize = host_aton(cb->host_address, incoming);
3046 host_mask(insize, incoming, mlen);
3047 (void)host_nmtoa(insize, incoming, mlen, buffer, sep);
3049 filename = semicolon + 1;
3052 /* Now do the actual lookup; note that there is no search_close() because
3053 of the caching arrangements. */
3055 if (!(handle = search_open(filename, search_type, 0, NULL, NULL)))
3056 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s", search_error_message);
3058 result = search_find(handle, filename, key, -1, NULL, 0, 0, NULL, opts);
3059 if (valueptr) *valueptr = result;
3060 return result ? OK : f.search_find_defer ? DEFER: FAIL;
3063 /* The pattern is not an IP address or network reference of any kind. That is,
3064 it is a host name pattern. If this is an IP only match, there's an error in the
3069 *error = US"cannot match host name in match_ip list";
3073 /* Check the characters of the pattern to see if they comprise only letters,
3074 digits, full stops, and hyphens (the constituents of domain names). Allow
3075 underscores, as they are all too commonly found. Sigh. Also, if
3076 allow_utf8_domains is set, allow top-bit characters. */
3078 for (t = ss; *t; t++)
3079 if (!isalnum(*t) && *t != '.' && *t != '-' && *t != '_' &&
3080 (!allow_utf8_domains || *t < 128)) break;
3082 /* If the pattern is a complete domain name, with no fancy characters, look up
3083 its IP address and match against that. Note that a multi-homed host will add
3084 items to the chain. */
3095 /* Using byname rather than bydns here means we cannot determine dnssec
3096 status. On the other hand it is unclear how that could be either
3097 propagated up or enforced. */
3099 rc = host_find_byname(&h, NULL, HOST_FIND_QUALIFY_SINGLE, NULL, FALSE);
3100 if (rc == HOST_FOUND || rc == HOST_FOUND_LOCAL)
3102 for (host_item * hh = &h; hh; hh = hh->next)
3103 if (host_is_in_net(hh->address, cb->host_address, 0)) return OK;
3106 if (rc == HOST_FIND_AGAIN) return DEFER;
3107 *error = string_sprintf("failed to find IP address for %s", ss);
3111 /* Almost all subsequent comparisons require the host name, and can be done
3112 using the general string matching function. When this function is called for
3113 outgoing hosts, the name is always given explicitly. If it is NULL, it means we
3114 must use sender_host_name and its aliases, looking them up if necessary. */
3116 if (cb->host_name) /* Explicit host name given */
3117 return match_check_string(cb->host_name, ss, -1,
3118 MCS_PARTIAL | MCS_CASELESS | MCS_AT_SPECIAL | cb->flags, valueptr);
3120 /* Host name not given; in principle we need the sender host name and its
3121 aliases. However, for query-style lookups, we do not need the name if the
3122 query does not contain $sender_host_name. From release 4.23, a reference to
3123 $sender_host_name causes it to be looked up, so we don't need to do the lookup
3126 if ((semicolon = Ustrchr(ss, ';')))
3128 const uschar * affix, * opts;
3129 int partial, affixlen, starflags, id;
3132 id = search_findtype_partial(ss, &partial, &affix, &affixlen, &starflags,
3136 if (id < 0) /* Unknown lookup type */
3138 log_write(0, LOG_MAIN|LOG_PANIC, "%s in host list item \"%s\"",
3139 search_error_message, ss);
3142 isquery = mac_islookup(id, lookup_querystyle|lookup_absfilequery);
3147 switch(match_check_string(US"", ss, -1,
3148 MCS_PARTIAL| MCS_CASELESS| MCS_AT_SPECIAL | (cb->flags & MCS_CACHEABLE),
3152 case DEFER: return DEFER;
3153 default: return FAIL;
3157 /* Not a query-style lookup; must ensure the host name is present, and then we
3158 do a check on the name and all its aliases. */
3160 if (!sender_host_name)
3162 HDEBUG(D_host_lookup)
3163 debug_printf("sender host name required, to match against %s\n", ss);
3164 if (host_lookup_failed || host_name_lookup() != OK)
3166 *error = string_sprintf("failed to find host name for %s",
3167 sender_host_address);;
3170 host_build_sender_fullhost();
3173 /* Match on the sender host name, using the general matching function */
3175 switch(match_check_string(sender_host_name, ss, -1,
3176 MCS_PARTIAL| MCS_CASELESS| MCS_AT_SPECIAL | (cb->flags & MCS_CACHEABLE),
3180 case DEFER: return DEFER;
3183 /* If there are aliases, try matching on them. */
3185 aliases = sender_host_aliases;
3187 switch(match_check_string(*aliases++, ss, -1,
3188 MCS_PARTIAL| MCS_CASELESS| MCS_AT_SPECIAL | (cb->flags & MCS_CACHEABLE),
3192 case DEFER: return DEFER;
3200 /*************************************************
3201 * Check a specific host matches a host list *
3202 *************************************************/
3204 /* This function is passed a host list containing items in a number of
3205 different formats and the identity of a host. Its job is to determine whether
3206 the given host is in the set of hosts defined by the list. The host name is
3207 passed as a pointer so that it can be looked up if needed and not already
3208 known. This is commonly the case when called from verify_check_host() to check
3209 an incoming connection. When called from elsewhere the host name should usually
3212 This function is now just a front end to match_check_list(), which runs common
3213 code for scanning a list. We pass it the check_host() function to perform a
3217 listptr pointer to the host list
3218 cache_bits pointer to cache for named lists, or NULL
3219 host_name the host name or NULL, implying use sender_host_name and
3220 sender_host_aliases, looking them up if required
3221 host_address the IP address
3222 valueptr if not NULL, data from a lookup is passed back here
3224 Returns: OK if the host is in the defined set
3225 FAIL if the host is not in the defined set,
3226 DEFER if a data lookup deferred (not a host lookup)
3228 If the host name was needed in order to make a comparison, and could not be
3229 determined from the IP address, the result is FAIL unless the item
3230 "+allow_unknown" was met earlier in the list, in which case OK is returned. */
3233 verify_check_this_host(const uschar **listptr, unsigned int *cache_bits,
3234 const uschar *host_name, const uschar *host_address, const uschar **valueptr)
3237 unsigned int *local_cache_bits = cache_bits;
3238 const uschar *save_host_address = deliver_host_address;
3239 check_host_block cb = { .host_name = host_name, .host_address = host_address };
3241 if (valueptr) *valueptr = NULL;
3243 /* If the host address starts off ::ffff: it is an IPv6 address in
3244 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3247 cb.host_ipv4 = Ustrncmp(host_address, "::ffff:", 7) == 0
3248 ? host_address + 7 : host_address;
3250 /* During the running of the check, put the IP address into $host_address. In
3251 the case of calls from the smtp transport, it will already be there. However,
3252 in other calls (e.g. when testing ignore_target_hosts), it won't. Just to be on
3253 the safe side, any existing setting is preserved, though as I write this
3254 (November 2004) I can't see any cases where it is actually needed. */
3256 deliver_host_address = host_address;
3257 rc = match_check_list(
3258 listptr, /* the list */
3259 0, /* separator character */
3260 &hostlist_anchor, /* anchor pointer */
3261 &local_cache_bits, /* cache pointer */
3262 check_host, /* function for testing */
3263 &cb, /* argument for function */
3264 MCL_HOST, /* type of check */
3265 host_address == sender_host_address
3266 ? US"host" : host_address, /* text for debugging */
3267 valueptr); /* where to pass back data */
3268 deliver_host_address = save_host_address;
3275 /*************************************************
3276 * Check the given host item matches a list *
3277 *************************************************/
3279 verify_check_given_host(const uschar **listptr, const host_item *host)
3281 return verify_check_this_host(listptr, NULL, host->name, host->address, NULL);
3284 /*************************************************
3285 * Check the remote host matches a list *
3286 *************************************************/
3288 /* This is a front end to verify_check_this_host(), created because checking
3289 the remote host is a common occurrence. With luck, a good compiler will spot
3290 the tail recursion and optimize it. If there's no host address, this is
3291 command-line SMTP input - check against an empty string for the address.
3294 listptr pointer to the host list
3296 Returns: the yield of verify_check_this_host(),
3297 i.e. OK, FAIL, or DEFER
3301 verify_check_host(uschar **listptr)
3303 return verify_check_this_host(CUSS listptr, sender_host_cache, NULL,
3304 sender_host_address ? sender_host_address : US"", NULL);
3311 /*************************************************
3312 * Invert an IP address *
3313 *************************************************/
3315 /* Originally just used for DNS xBL lists, now also used for the
3316 reverse_ip expansion operator.
3319 buffer where to put the answer
3320 address the address to invert
3324 invert_address(uschar *buffer, uschar *address)
3327 uschar *bptr = buffer;
3329 /* If this is an IPv4 address mapped into IPv6 format, adjust the pointer
3330 to the IPv4 part only. */
3332 if (Ustrncmp(address, "::ffff:", 7) == 0) address += 7;
3334 /* Handle IPv4 address: when HAVE_IPV6 is false, the result of host_aton() is
3337 if (host_aton(address, bin) == 1)
3340 for (int i = 0; i < 4; i++)
3342 sprintf(CS bptr, "%d.", x & 255);
3343 while (*bptr) bptr++;
3348 /* Handle IPv6 address. Actually, as far as I know, there are no IPv6 addresses
3349 in any DNS black lists, and the format in which they will be looked up is
3350 unknown. This is just a guess. */
3354 for (int j = 3; j >= 0; j--)
3357 for (int i = 0; i < 8; i++)
3359 sprintf(CS bptr, "%x.", x & 15);
3360 while (*bptr) bptr++;
3366 /* Remove trailing period -- this is needed so that both arbitrary
3367 dnsbl keydomains and inverted addresses may be combined with the
3368 same format string, "%s.%s" */
3375 /****************************************************
3376 Verify a local user account for quota sufficiency
3377 ****************************************************/
3379 /* The real work, done via a re-exec for privs, calls
3380 down to the transport for the quota check.
3382 Route and transport (in recipient-verify mode) the
3385 A routing result indicating any transport type other than appendfile
3388 Return, on stdout, a result string containing:
3389 - highlevel result code (OK, DEFER, FAIL)
3396 verify_quota(uschar * address)
3398 address_item vaddr = {.address = address};
3400 uschar * msg = US"\0";
3403 if ((rc = verify_address(&vaddr, NULL, vopt_is_recipient | vopt_quota,
3404 1, 0, 0, NULL, NULL, &routed)) != OK)
3406 uschar * where = recipient_verify_failure;
3407 msg = acl_verify_message ? acl_verify_message : vaddr.message;
3408 if (!msg) msg = US"";
3409 if (rc == DEFER && vaddr.basic_errno == ERRNO_EXIMQUOTA)
3411 rc = FAIL; /* DEFER -> FAIL */
3413 vaddr.basic_errno = 0;
3415 else if (!where) where = US"";
3417 len = 5 + Ustrlen(msg) + 1 + Ustrlen(where);
3418 msg = string_sprintf("%c%c%c%c%c%s%c%s", (uschar)rc,
3419 (vaddr.basic_errno >> 24) & 0xff, (vaddr.basic_errno >> 16) & 0xff,
3420 (vaddr.basic_errno >> 8) & 0xff, vaddr.basic_errno & 0xff,
3424 DEBUG(D_verify) debug_printf_indent("verify_quota: len %d\n", len);
3430 /******************************************************************************/
3432 /* Quota cache lookup. We use the callout hints db also for the quota cache.
3433 Return TRUE if a nonexpired record was found, having filled in the yield
3438 cached_quota_lookup(const uschar * rcpt, int * yield,
3439 int pos_cache, int neg_cache)
3441 open_db dbblock, *dbm_file = NULL;
3442 dbdata_callout_cache_address * cache_address_record;
3444 if (!pos_cache && !neg_cache)
3446 if (!(dbm_file = dbfn_open(US"callout", O_RDWR, &dbblock, FALSE, TRUE)))
3448 HDEBUG(D_verify) debug_printf_indent("quota cache: not available\n");
3451 if (!(cache_address_record = (dbdata_callout_cache_address *)
3452 get_callout_cache_record(dbm_file, rcpt, US"address",
3453 pos_cache, neg_cache)))
3455 dbfn_close(dbm_file);
3458 if (cache_address_record->result == ccache_accept)
3460 dbfn_close(dbm_file);
3464 /* Quota cache write */
3467 cache_quota_write(const uschar * rcpt, int yield, int pos_cache, int neg_cache)
3469 open_db dbblock, *dbm_file = NULL;
3470 dbdata_callout_cache_address cache_address_record;
3472 if (!pos_cache && !neg_cache)
3474 if (!(dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE, TRUE)))
3476 HDEBUG(D_verify) debug_printf_indent("quota cache: not available\n");
3480 cache_address_record.result = yield == OK ? ccache_accept : ccache_reject;
3482 (void)dbfn_write(dbm_file, rcpt, &cache_address_record,
3483 (int)sizeof(dbdata_callout_cache_address));
3484 HDEBUG(D_verify) debug_printf_indent("wrote %s quota cache record for %s\n",
3485 yield == OK ? "positive" : "negative", rcpt);
3487 dbfn_close(dbm_file);
3492 /* To evaluate a local user's quota, starting in ACL, we need to
3493 fork & exec to regain privileges, to that we can change to the user's
3494 identity for access to their files.
3497 rcpt Recipient account
3498 pos_cache Number of seconds to cache a positive result (delivery
3499 to be accepted). Zero to disable caching.
3500 neg_cache Number of seconds to cache a negative result. Zero to disable.
3501 msg Pointer to result string pointer
3503 Return: OK/DEFER/FAIL code
3507 verify_quota_call(const uschar * rcpt, int pos_cache, int neg_cache,
3510 int pfd[2], pid, save_errno, yield = FAIL;
3511 void (*oldsignal)(int);
3512 const uschar * where = US"socketpair";
3516 if (cached_quota_lookup(rcpt, &yield, pos_cache, neg_cache))
3518 HDEBUG(D_verify) debug_printf_indent("quota cache: address record is %s\n",
3519 yield == OK ? "positive" : "negative");
3522 recipient_verify_failure = US"quota";
3523 acl_verify_message = *msg =
3524 US"Previous (cached) quota verification failure";
3533 oldsignal = signal(SIGCHLD, SIG_DFL);
3534 if ((pid = exim_fork(US"quota-verify")) < 0)
3537 close(pfd[pipe_write]);
3538 close(pfd[pipe_read]);
3543 if (pid == 0) /* child */
3545 close(pfd[pipe_read]);
3546 force_fd(pfd[pipe_write], 1); /* stdout to pipe */
3547 close(pfd[pipe_write]);
3549 if (debug_fd > 0) force_fd(debug_fd, 2);
3551 child_exec_exim(CEE_EXEC_EXIT, FALSE, NULL, FALSE, 3,
3552 US"-MCq", string_sprintf("%d", message_size), rcpt);
3557 close(pfd[pipe_write]);
3561 DEBUG(D_verify) debug_printf_indent(" fork: %s\n", strerror(save_errno));
3566 int n = read(pfd[pipe_read], buf, sizeof(buf));
3569 waitpid(pid, &status, 0);
3574 if (n > 0) yield = buf[0];
3576 save_errno = (buf[1] << 24) | (buf[2] << 16) | (buf[3] << 8) | buf[4];
3577 if ((recipient_verify_failure = n > 5
3578 ? string_copyn_taint(buf+5, n-5, GET_UNTAINTED) : NULL))
3581 s = buf + 5 + Ustrlen(recipient_verify_failure) + 1;
3583 acl_verify_message = *msg =
3584 m > 0 ? string_copyn_taint(s, m, GET_UNTAINTED) : NULL;
3587 DEBUG(D_verify) debug_printf_indent("verify call response:"
3588 " len %d yield %s errno '%s' where '%s' msg '%s'\n",
3589 n, rc_names[yield], strerror(save_errno), recipient_verify_failure, *msg);
3592 || save_errno == 0 && Ustrcmp(recipient_verify_failure, "quota") == 0)
3593 cache_quota_write(rcpt, yield, pos_cache, neg_cache);
3594 else DEBUG(D_verify)
3595 debug_printf_indent("result not cacheable\n");
3600 debug_printf_indent("verify call response: waitpid status 0x%04x\n", status);
3604 close(pfd[pipe_read]);
3605 signal(SIGCHLD, oldsignal);
3610 DEBUG(D_verify) debug_printf_indent("verify_quota_call fail in %s\n", where);
3617 /* End of verify.c */