1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2017 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Functions concerned with verifying things. The original code for callout
9 caching was contributed by Kevin Fleming (but I hacked it around a bit). */
13 #include "transports/smtp.h"
15 #define CUTTHROUGH_CMD_TIMEOUT 30 /* timeout for cutthrough-routing calls */
16 #define CUTTHROUGH_DATA_TIMEOUT 60 /* timeout for cutthrough-routing calls */
17 static smtp_outblock ctblock
;
18 uschar ctbuffer
[8192];
21 /* Structure for caching DNSBL lookups */
23 typedef struct dnsbl_cache_block
{
32 /* Anchor for DNSBL cache */
34 static tree_node
*dnsbl_cache
= NULL
;
37 /* Bits for match_type in one_check_dnsbl() */
42 static uschar
cutthrough_response(int, char, uschar
**, int);
46 /*************************************************
47 * Retrieve a callout cache record *
48 *************************************************/
50 /* If a record exists, check whether it has expired.
53 dbm_file an open hints file
55 type "address" or "domain"
56 positive_expire expire time for positive records
57 negative_expire expire time for negative records
59 Returns: the cache record if a non-expired one exists, else NULL
62 static dbdata_callout_cache
*
63 get_callout_cache_record(open_db
*dbm_file
, const uschar
*key
, uschar
*type
,
64 int positive_expire
, int negative_expire
)
69 dbdata_callout_cache
*cache_record
;
71 cache_record
= dbfn_read_with_length(dbm_file
, key
, &length
);
73 if (cache_record
== NULL
)
75 HDEBUG(D_verify
) debug_printf("callout cache: no %s record found for %s\n", type
, key
);
79 /* We treat a record as "negative" if its result field is not positive, or if
80 it is a domain record and the postmaster field is negative. */
82 negative
= cache_record
->result
!= ccache_accept
||
83 (type
[0] == 'd' && cache_record
->postmaster_result
== ccache_reject
);
84 expire
= negative
? negative_expire
: positive_expire
;
87 if (now
- cache_record
->time_stamp
> expire
)
89 HDEBUG(D_verify
) debug_printf("callout cache: %s record expired for %s\n", type
, key
);
93 /* If this is a non-reject domain record, check for the obsolete format version
94 that doesn't have the postmaster and random timestamps, by looking at the
95 length. If so, copy it to a new-style block, replicating the record's
96 timestamp. Then check the additional timestamps. (There's no point wasting
97 effort if connections are rejected.) */
99 if (type
[0] == 'd' && cache_record
->result
!= ccache_reject
)
101 if (length
== sizeof(dbdata_callout_cache_obs
))
103 dbdata_callout_cache
*new = store_get(sizeof(dbdata_callout_cache
));
104 memcpy(new, cache_record
, length
);
105 new->postmaster_stamp
= new->random_stamp
= new->time_stamp
;
109 if (now
- cache_record
->postmaster_stamp
> expire
)
110 cache_record
->postmaster_result
= ccache_unknown
;
112 if (now
- cache_record
->random_stamp
> expire
)
113 cache_record
->random_result
= ccache_unknown
;
116 HDEBUG(D_verify
) debug_printf("callout cache: found %s record for %s\n", type
, key
);
122 /* Check the callout cache.
123 Options * pm_mailfrom may be modified by cache partial results.
125 Return: TRUE if result found
129 cached_callout_lookup(address_item
* addr
, uschar
* address_key
,
130 uschar
* from_address
, int * opt_ptr
, uschar
** pm_ptr
,
131 int * yield
, uschar
** failure_ptr
,
132 dbdata_callout_cache
* new_domain_record
, int * old_domain_res
)
134 int options
= *opt_ptr
;
136 open_db
*dbm_file
= NULL
;
138 /* Open the callout cache database, it it exists, for reading only at this
139 stage, unless caching has been disabled. */
141 if (options
& vopt_callout_no_cache
)
143 HDEBUG(D_verify
) debug_printf("callout cache: disabled by no_cache\n");
145 else if (!(dbm_file
= dbfn_open(US
"callout", O_RDWR
, &dbblock
, FALSE
)))
147 HDEBUG(D_verify
) debug_printf("callout cache: not available\n");
151 /* If a cache database is available see if we can avoid the need to do an
152 actual callout by making use of previously-obtained data. */
154 dbdata_callout_cache_address
* cache_address_record
;
155 dbdata_callout_cache
* cache_record
= get_callout_cache_record(dbm_file
,
156 addr
->domain
, US
"domain",
157 callout_cache_domain_positive_expire
, callout_cache_domain_negative_expire
);
159 /* If an unexpired cache record was found for this domain, see if the callout
160 process can be short-circuited. */
164 /* In most cases, if an early command (up to and including MAIL FROM:<>)
165 was rejected, there is no point carrying on. The callout fails. However, if
166 we are doing a recipient verification with use_sender or use_postmaster
167 set, a previous failure of MAIL FROM:<> doesn't count, because this time we
168 will be using a non-empty sender. We have to remember this situation so as
169 not to disturb the cached domain value if this whole verification succeeds
170 (we don't want it turning into "accept"). */
172 *old_domain_res
= cache_record
->result
;
174 if ( cache_record
->result
== ccache_reject
175 || *from_address
== 0 && cache_record
->result
== ccache_reject_mfnull
)
177 setflag(addr
, af_verify_nsfail
);
179 debug_printf("callout cache: domain gave initial rejection, or "
180 "does not accept HELO or MAIL FROM:<>\n");
181 setflag(addr
, af_verify_nsfail
);
182 addr
->user_message
= US
"(result of an earlier callout reused).";
184 *failure_ptr
= US
"mail";
185 dbfn_close(dbm_file
);
189 /* If a previous check on a "random" local part was accepted, we assume
190 that the server does not do any checking on local parts. There is therefore
191 no point in doing the callout, because it will always be successful. If a
192 random check previously failed, arrange not to do it again, but preserve
193 the data in the new record. If a random check is required but hasn't been
194 done, skip the remaining cache processing. */
196 if (options
& vopt_callout_random
) switch(cache_record
->random_result
)
200 debug_printf("callout cache: domain accepts random addresses\n");
201 dbfn_close(dbm_file
);
202 return TRUE
; /* Default yield is OK */
206 debug_printf("callout cache: domain rejects random addresses\n");
207 *opt_ptr
= options
& ~vopt_callout_random
;
208 new_domain_record
->random_result
= ccache_reject
;
209 new_domain_record
->random_stamp
= cache_record
->random_stamp
;
214 debug_printf("callout cache: need to check random address handling "
215 "(not cached or cache expired)\n");
216 dbfn_close(dbm_file
);
220 /* If a postmaster check is requested, but there was a previous failure,
221 there is again no point in carrying on. If a postmaster check is required,
222 but has not been done before, we are going to have to do a callout, so skip
223 remaining cache processing. */
227 if (cache_record
->postmaster_result
== ccache_reject
)
229 setflag(addr
, af_verify_pmfail
);
231 debug_printf("callout cache: domain does not accept "
232 "RCPT TO:<postmaster@domain>\n");
234 *failure_ptr
= US
"postmaster";
235 setflag(addr
, af_verify_pmfail
);
236 addr
->user_message
= US
"(result of earlier verification reused).";
237 dbfn_close(dbm_file
);
240 if (cache_record
->postmaster_result
== ccache_unknown
)
243 debug_printf("callout cache: need to check RCPT "
244 "TO:<postmaster@domain> (not cached or cache expired)\n");
245 dbfn_close(dbm_file
);
249 /* If cache says OK, set pm_mailfrom NULL to prevent a redundant
250 postmaster check if the address itself has to be checked. Also ensure
251 that the value in the cache record is preserved (with its old timestamp).
254 HDEBUG(D_verify
) debug_printf("callout cache: domain accepts RCPT "
255 "TO:<postmaster@domain>\n");
257 new_domain_record
->postmaster_result
= ccache_accept
;
258 new_domain_record
->postmaster_stamp
= cache_record
->postmaster_stamp
;
262 /* We can't give a result based on information about the domain. See if there
263 is an unexpired cache record for this specific address (combined with the
264 sender address if we are doing a recipient callout with a non-empty sender).
267 if (!(cache_address_record
= (dbdata_callout_cache_address
*)
268 get_callout_cache_record(dbm_file
, address_key
, US
"address",
269 callout_cache_positive_expire
, callout_cache_negative_expire
)))
271 dbfn_close(dbm_file
);
275 if (cache_address_record
->result
== ccache_accept
)
278 debug_printf("callout cache: address record is positive\n");
283 debug_printf("callout cache: address record is negative\n");
284 addr
->user_message
= US
"Previous (cached) callout verification failure";
285 *failure_ptr
= US
"recipient";
289 /* Close the cache database while we actually do the callout for real. */
291 dbfn_close(dbm_file
);
298 /* Write results to callout cache
301 cache_callout_write(dbdata_callout_cache
* dom_rec
, const uschar
* domain
,
302 int done
, dbdata_callout_cache_address
* addr_rec
, uschar
* address_key
)
305 open_db
*dbm_file
= NULL
;
307 /* If we get here with done == TRUE, a successful callout happened, and yield
308 will be set OK or FAIL according to the response to the RCPT command.
309 Otherwise, we looped through the hosts but couldn't complete the business.
310 However, there may be domain-specific information to cache in both cases.
312 The value of the result field in the new_domain record is ccache_unknown if
313 there was an error before or with MAIL FROM:, and errno was not zero,
314 implying some kind of I/O error. We don't want to write the cache in that case.
315 Otherwise the value is ccache_accept, ccache_reject, or ccache_reject_mfnull. */
317 if (dom_rec
->result
!= ccache_unknown
)
318 if (!(dbm_file
= dbfn_open(US
"callout", O_RDWR
|O_CREAT
, &dbblock
, FALSE
)))
320 HDEBUG(D_verify
) debug_printf("callout cache: not available\n");
324 (void)dbfn_write(dbm_file
, domain
, dom_rec
,
325 (int)sizeof(dbdata_callout_cache
));
326 HDEBUG(D_verify
) debug_printf("wrote callout cache domain record for %s:\n"
327 " result=%d postmaster=%d random=%d\n",
330 dom_rec
->postmaster_result
,
331 dom_rec
->random_result
);
334 /* If a definite result was obtained for the callout, cache it unless caching
337 if (done
&& addr_rec
->result
!= ccache_unknown
)
340 dbm_file
= dbfn_open(US
"callout", O_RDWR
|O_CREAT
, &dbblock
, FALSE
);
343 HDEBUG(D_verify
) debug_printf("no callout cache available\n");
347 (void)dbfn_write(dbm_file
, address_key
, addr_rec
,
348 (int)sizeof(dbdata_callout_cache_address
));
349 HDEBUG(D_verify
) debug_printf("wrote %s callout cache address record for %s\n",
350 addr_rec
->result
== ccache_accept
? "positive" : "negative",
355 if (dbm_file
) dbfn_close(dbm_file
);
359 /* Cutthrough-multi. If the existing cached cutthrough connection matches
360 the one we would make for a subsequent recipient, use it. Send the RCPT TO
361 and check the result, nonpipelined as it may be wanted immediately for
362 recipient-verification.
364 It seems simpler to deal with this case separately from the main callout loop.
365 We will need to remember it has sent, or not, so that rcpt-acl tail code
366 can do it there for the non-rcpt-verify case. For this we keep an addresscount.
368 Return: TRUE for a definitive result for the recipient
371 cutthrough_multi(address_item
* addr
, host_item
* host_list
,
372 transport_feedback
* tf
, int * yield
)
377 if (addr
->transport
== cutthrough
.addr
.transport
)
378 for (host
= host_list
; host
; host
= host
->next
)
379 if (Ustrcmp(host
->address
, cutthrough
.host
.address
) == 0)
382 uschar
*interface
= NULL
; /* Outgoing interface to use; NULL => any */
385 deliver_host
= host
->name
;
386 deliver_host_address
= host
->address
;
387 deliver_host_port
= host
->port
;
388 deliver_domain
= addr
->domain
;
389 transport_name
= addr
->transport
->name
;
391 host_af
= Ustrchr(host
->address
, ':') ? AF_INET6
: AF_INET
;
393 if (!smtp_get_interface(tf
->interface
, host_af
, addr
, &interface
,
395 !smtp_get_port(tf
->port
, addr
, &port
, US
"callout"))
396 log_write(0, LOG_MAIN
|LOG_PANIC
, "<%s>: %s", addr
->address
,
399 if ( ( interface
== cutthrough
.interface
401 && cutthrough
.interface
402 && Ustrcmp(interface
, cutthrough
.interface
) == 0
404 && port
== cutthrough
.host
.port
407 uschar
* resp
= NULL
;
409 /* Match! Send the RCPT TO, set done from the response */
411 smtp_write_command(&ctblock
, SCMD_FLUSH
, "RCPT TO:<%.1000s>\r\n",
412 transport_rcpt_address(addr
,
413 addr
->transport
->rcpt_include_affixes
)) >= 0 &&
414 cutthrough_response(cutthrough
.fd
, '2', &resp
, CUTTHROUGH_DATA_TIMEOUT
) == '2';
416 /* This would go horribly wrong if a callout fail was ignored by ACL.
417 We punt by abandoning cutthrough on a reject, like the
422 address_item
* na
= store_get(sizeof(address_item
));
423 *na
= cutthrough
.addr
;
424 cutthrough
.addr
= *addr
;
425 cutthrough
.addr
.host_used
= &cutthrough
.host
;
426 cutthrough
.addr
.next
= na
;
432 cancel_cutthrough_connection(TRUE
, US
"recipient rejected");
433 if (!resp
|| errno
== ETIMEDOUT
)
435 HDEBUG(D_verify
) debug_printf("SMTP timeout\n");
440 Ustrcpy(resp
, US
"connection dropped");
443 string_sprintf("response to \"%s\" was: %s",
444 big_buffer
, string_printing(resp
));
447 string_sprintf("Callout verification failed:\n%s", resp
);
449 /* Hard rejection ends the process */
451 if (resp
[0] == '5') /* Address rejected */
459 break; /* host_list */
462 cancel_cutthrough_connection(TRUE
, US
"incompatible connection");
467 /*************************************************
468 * Do callout verification for an address *
469 *************************************************/
471 /* This function is called from verify_address() when the address has routed to
472 a host list, and a callout has been requested. Callouts are expensive; that is
473 why a cache is used to improve the efficiency.
476 addr the address that's been routed
477 host_list the list of hosts to try
478 tf the transport feedback block
480 ifstring "interface" option from transport, or NULL
481 portstring "port" option from transport, or NULL
482 protocolstring "protocol" option from transport, or NULL
483 callout the per-command callout timeout
484 callout_overall the overall callout timeout (if < 0 use 4*callout)
485 callout_connect the callout connection timeout (if < 0 use callout)
486 options the verification options - these bits are used:
487 vopt_is_recipient => this is a recipient address
488 vopt_callout_no_cache => don't use callout cache
489 vopt_callout_fullpm => if postmaster check, do full one
490 vopt_callout_random => do the "random" thing
491 vopt_callout_recipsender => use real sender for recipient
492 vopt_callout_recippmaster => use postmaster for recipient
493 vopt_callout_hold => lazy close connection
494 se_mailfrom MAIL FROM address for sender verify; NULL => ""
495 pm_mailfrom if non-NULL, do the postmaster check with this sender
497 Returns: OK/FAIL/DEFER
501 do_callout(address_item
*addr
, host_item
*host_list
, transport_feedback
*tf
,
502 int callout
, int callout_overall
, int callout_connect
, int options
,
503 uschar
*se_mailfrom
, uschar
*pm_mailfrom
)
506 int old_domain_cache_result
= ccache_accept
;
509 uschar
*from_address
;
510 uschar
*random_local_part
= NULL
;
511 const uschar
*save_deliver_domain
= deliver_domain
;
512 uschar
**failure_ptr
= options
& vopt_is_recipient
513 ? &recipient_verify_failure
: &sender_verify_failure
;
514 dbdata_callout_cache new_domain_record
;
515 dbdata_callout_cache_address new_address_record
;
516 time_t callout_start_time
;
518 new_domain_record
.result
= ccache_unknown
;
519 new_domain_record
.postmaster_result
= ccache_unknown
;
520 new_domain_record
.random_result
= ccache_unknown
;
522 memset(&new_address_record
, 0, sizeof(new_address_record
));
524 /* For a recipient callout, the key used for the address cache record must
525 include the sender address if we are using the real sender in the callout,
526 because that may influence the result of the callout. */
528 if (options
& vopt_is_recipient
)
529 if (options
& vopt_callout_recipsender
)
531 from_address
= sender_address
;
532 address_key
= string_sprintf("%s/<%s>", addr
->address
, sender_address
);
533 if (cutthrough
.delivery
) options
|= vopt_callout_no_cache
;
535 else if (options
& vopt_callout_recippmaster
)
537 from_address
= string_sprintf("postmaster@%s", qualify_domain_sender
);
538 address_key
= string_sprintf("%s/<postmaster@%s>", addr
->address
,
539 qualify_domain_sender
);
544 address_key
= addr
->address
;
547 /* For a sender callout, we must adjust the key if the mailfrom address is not
552 from_address
= se_mailfrom
? se_mailfrom
: US
"";
553 address_key
= *from_address
554 ? string_sprintf("%s/<%s>", addr
->address
, from_address
) : addr
->address
;
557 if (cached_callout_lookup(addr
, address_key
, from_address
,
558 &options
, &pm_mailfrom
, &yield
, failure_ptr
,
559 &new_domain_record
, &old_domain_cache_result
))
561 cancel_cutthrough_connection(TRUE
, US
"cache-hit");
565 if (!addr
->transport
)
567 HDEBUG(D_verify
) debug_printf("cannot callout via null transport\n");
569 else if (Ustrcmp(addr
->transport
->driver_name
, "smtp") != 0)
570 log_write(0, LOG_MAIN
|LOG_PANIC
|LOG_CONFIG_FOR
, "callout transport '%s': %s is non-smtp",
571 addr
->transport
->name
, addr
->transport
->driver_name
);
574 smtp_transport_options_block
*ob
=
575 (smtp_transport_options_block
*)addr
->transport
->options_block
;
578 /* The information wasn't available in the cache, so we have to do a real
579 callout and save the result in the cache for next time, unless no_cache is set,
580 or unless we have a previously cached negative random result. If we are to test
581 with a random local part, ensure that such a local part is available. If not,
582 log the fact, but carry on without randomising. */
584 if (options
& vopt_callout_random
&& callout_random_local_part
)
585 if (!(random_local_part
= expand_string(callout_random_local_part
)))
586 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to expand "
587 "callout_random_local_part: %s", expand_string_message
);
589 /* Default the connect and overall callout timeouts if not set, and record the
590 time we are starting so that we can enforce it. */
592 if (callout_overall
< 0) callout_overall
= 4 * callout
;
593 if (callout_connect
< 0) callout_connect
= callout
;
594 callout_start_time
= time(NULL
);
596 /* Before doing a real callout, if this is an SMTP connection, flush the SMTP
597 output because a callout might take some time. When PIPELINING is active and
598 there are many recipients, the total time for doing lots of callouts can add up
599 and cause the client to time out. So in this case we forgo the PIPELINING
602 if (smtp_out
&& !disable_callout_flush
) mac_smtp_fflush();
604 clearflag(addr
, af_verify_pmfail
); /* postmaster callout flag */
605 clearflag(addr
, af_verify_nsfail
); /* null sender callout flag */
607 /* cutthrough-multi: if a nonfirst rcpt has the same routing as the first,
608 and we are holding a cutthrough conn open, we can just append the rcpt to
609 that conn for verification purposes (and later delivery also). Simplest
610 coding means skipping this whole loop and doing the append separately. */
612 /* Can we re-use an open cutthrough connection? */
613 if ( cutthrough
.fd
>= 0
614 && (options
& (vopt_callout_recipsender
| vopt_callout_recippmaster
))
615 == vopt_callout_recipsender
616 && !random_local_part
619 done
= cutthrough_multi(addr
, host_list
, tf
, &yield
);
621 /* If we did not use a cached connection, make connections to the hosts
622 and do real callouts. The list of hosts is passed in as an argument. */
624 for (host
= host_list
; host
&& !done
; host
= host
->next
)
628 uschar
*interface
= NULL
; /* Outgoing interface to use; NULL => any */
633 DEBUG(D_verify
) debug_printf("no IP address for host name %s: skipping\n",
638 /* Check the overall callout timeout */
640 if (time(NULL
) - callout_start_time
>= callout_overall
)
642 HDEBUG(D_verify
) debug_printf("overall timeout for callout exceeded\n");
646 /* Set IPv4 or IPv6 */
648 host_af
= Ustrchr(host
->address
, ':') ? AF_INET6
: AF_INET
;
650 /* Expand and interpret the interface and port strings. The latter will not
651 be used if there is a host-specific port (e.g. from a manualroute router).
652 This has to be delayed till now, because they may expand differently for
653 different hosts. If there's a failure, log it, but carry on with the
656 deliver_host
= host
->name
;
657 deliver_host_address
= host
->address
;
658 deliver_host_port
= host
->port
;
659 deliver_domain
= addr
->domain
;
660 transport_name
= addr
->transport
->name
;
662 if ( !smtp_get_interface(tf
->interface
, host_af
, addr
, &interface
,
664 || !smtp_get_port(tf
->port
, addr
, &port
, US
"callout")
666 log_write(0, LOG_MAIN
|LOG_PANIC
, "<%s>: %s", addr
->address
,
671 sx
.host_af
= host_af
,
673 sx
.interface
= interface
;
674 sx
.helo_data
= tf
->helo_data
;
675 sx
.tblock
= addr
->transport
;
678 tls_retry_connection
:
679 /* Set the address state so that errors are recorded in it */
681 addr
->transport_return
= PENDING_DEFER
;
682 ob
->connect_timeout
= callout_connect
;
683 ob
->command_timeout
= callout
;
685 /* Get the channel set up ready for a message (MAIL FROM being the next
686 SMTP command to send. If we tried TLS but it failed, try again without
689 yield
= smtp_setup_conn(&sx
, FALSE
);
692 && addr
->basic_errno
== ERRNO_TLSFAILURE
693 && ob
->tls_tempfail_tryclear
694 && verify_check_given_host(&ob
->hosts_require_tls
, host
) != OK
697 log_write(0, LOG_MAIN
,
698 "%s: callout unencrypted to %s [%s] (not in hosts_require_tls)",
699 addr
->message
, host
->name
, host
->address
);
700 addr
->transport_return
= PENDING_DEFER
;
701 yield
= smtp_setup_conn(&sx
, TRUE
);
706 errno
= addr
->basic_errno
;
707 transport_name
= NULL
;
708 deliver_host
= deliver_host_address
= NULL
;
709 deliver_domain
= save_deliver_domain
;
711 /* Failure to accept HELO is cached; this blocks the whole domain for all
712 senders. I/O errors and defer responses are not cached. */
714 if (yield
== FAIL
&& (errno
== 0 || errno
== ERRNO_SMTPCLOSED
))
716 setflag(addr
, af_verify_nsfail
);
717 new_domain_record
.result
= ccache_reject
;
725 /* If we needed to authenticate, smtp_setup_conn() did that. Copy
726 the AUTH info for logging */
728 addr
->authenticator
= client_authenticator
;
729 addr
->auth_id
= client_authenticated_id
;
731 sx
.from_addr
= from_address
;
732 sx
.first_addr
= sx
.sync_addr
= addr
;
733 sx
.ok
= FALSE
; /*XXX these 3 last might not be needed for verify? */
735 sx
.completed_addr
= FALSE
;
737 new_domain_record
.result
= old_domain_cache_result
== ccache_reject_mfnull
738 ? ccache_reject_mfnull
: ccache_accept
;
740 /* Do the random local part check first. Temporarily replace the recipient
741 with the "random" value */
743 if (random_local_part
)
745 uschar
* main_address
= addr
->address
;
746 const uschar
* rcpt_domain
= addr
->domain
;
749 uschar
* errstr
= NULL
;
750 if ( testflag(addr
, af_utf8_downcvt
)
751 && (rcpt_domain
= string_domain_utf8_to_alabel(rcpt_domain
,
755 addr
->message
= errstr
;
756 errno
= ERRNO_EXPANDFAIL
;
757 setflag(addr
, af_verify_nsfail
);
759 rcpt_domain
= US
""; /*XXX errorhandling! */
763 /* This would be ok for 1st rcpt of a cutthrough (the case handled here;
764 subsequents are done in cutthrough_multi()), but no way to
765 handle a subsequent because of the RSET vaporising the MAIL FROM.
766 So refuse to support any. Most cutthrough use will not involve
767 random_local_part, so no loss. */
768 cancel_cutthrough_connection(TRUE
, US
"random-recipient");
770 addr
->address
= string_sprintf("%s@%.1000s",
771 random_local_part
, rcpt_domain
);
774 /* If accepted, we aren't going to do any further tests below.
775 Otherwise, cache a real negative response, and get back to the right
776 state to send RCPT. Unless there's some problem such as a dropped
777 connection, we expect to succeed, because the commands succeeded above.
778 However, some servers drop the connection after responding to an
779 invalid recipient, so on (any) error we drop and remake the connection.
780 XXX We don't care about that for postmaster_full. Should we?
782 XXX could we add another flag to the context, and have the common
783 code emit the RSET too? Even pipelined after the RCPT...
784 Then the main-verify call could use it if there's to be a subsequent
786 The sync_responses() would need to be taught about it and we'd
787 need another return code filtering out to here.
790 /* Remember when we last did a random test */
791 new_domain_record
.random_stamp
= time(NULL
);
793 if (smtp_write_mail_and_rcpt_cmds(&sx
, &yield
) == 0)
794 switch(addr
->transport_return
)
797 new_domain_record
.random_result
= ccache_accept
;
800 new_domain_record
.random_result
= ccache_reject
;
802 /* Between each check, issue RSET, because some servers accept only
803 one recipient after MAIL FROM:<>.
804 XXX We don't care about that for postmaster_full. Should we? */
807 smtp_write_command(&sx
.outblock
, SCMD_FLUSH
, "RSET\r\n") >= 0 &&
808 smtp_read_response(&sx
.inblock
, sx
.buffer
, sizeof(sx
.buffer
),
813 debug_printf_indent("problem after random/rset/mfrom; reopen conn\n");
814 random_local_part
= NULL
;
816 tls_close(FALSE
, TRUE
);
818 HDEBUG(D_transport
|D_acl
|D_v
) debug_printf_indent(" SMTP(close)>>\n");
819 (void)close(sx
.inblock
.sock
);
820 sx
.inblock
.sock
= sx
.outblock
.sock
= -1;
821 #ifndef DISABLE_EVENT
822 (void) event_raise(addr
->transport
->event_action
,
823 US
"tcp:close", NULL
);
825 addr
->address
= main_address
;
826 addr
->transport_return
= PENDING_DEFER
;
827 sx
.first_addr
= sx
.sync_addr
= addr
;
830 sx
.completed_addr
= FALSE
;
831 goto tls_retry_connection
;
834 /* Re-setup for main verify, or for the error message when failing */
835 addr
->address
= main_address
;
836 addr
->transport_return
= PENDING_DEFER
;
837 sx
.first_addr
= sx
.sync_addr
= addr
;
840 sx
.completed_addr
= FALSE
;
845 /* Main verify. If the host is accepting all local parts, as determined
846 by the "random" check, we don't need to waste time doing any further
852 switch(smtp_write_mail_and_rcpt_cmds(&sx
, &yield
))
854 case 0: switch(addr
->transport_return
) /* ok so far */
856 case PENDING_OK
: done
= TRUE
;
857 new_address_record
.result
= ccache_accept
;
859 case FAIL
: done
= TRUE
;
861 *failure_ptr
= US
"recipient";
862 new_address_record
.result
= ccache_reject
;
868 case -1: /* MAIL response error */
869 *failure_ptr
= US
"mail";
870 if (errno
== 0 && sx
.buffer
[0] == '5')
872 setflag(addr
, af_verify_nsfail
);
873 if (from_address
[0] == 0)
874 new_domain_record
.result
= ccache_reject_mfnull
;
877 /* non-MAIL read i/o error */
878 /* non-MAIL response timeout */
879 /* internal error; channel still usable */
880 default: break; /* transmit failed */
884 addr
->auth_sndr
= client_authenticated_sender
;
886 deliver_host
= deliver_host_address
= NULL
;
887 deliver_domain
= save_deliver_domain
;
889 /* Do postmaster check if requested; if a full check is required, we
890 check for RCPT TO:<postmaster> (no domain) in accordance with RFC 821. */
892 if (done
&& pm_mailfrom
)
894 /* Could possibly shift before main verify, just above, and be ok
895 for cutthrough. But no way to handle a subsequent rcpt, so just
897 cancel_cutthrough_connection(TRUE
, US
"postmaster verify");
898 HDEBUG(D_acl
|D_v
) debug_printf_indent("Cutthrough cancelled by presence of postmaster verify\n");
900 done
= smtp_write_command(&sx
.outblock
, SCMD_FLUSH
, "RSET\r\n") >= 0
901 && smtp_read_response(&sx
.inblock
, sx
.buffer
,
902 sizeof(sx
.buffer
), '2', callout
);
906 uschar
* main_address
= addr
->address
;
908 /*XXX oops, affixes */
909 addr
->address
= string_sprintf("postmaster@%.1000s", addr
->domain
);
910 addr
->transport_return
= PENDING_DEFER
;
912 sx
.from_addr
= pm_mailfrom
;
913 sx
.first_addr
= sx
.sync_addr
= addr
;
916 sx
.completed_addr
= FALSE
;
918 if( smtp_write_mail_and_rcpt_cmds(&sx
, &yield
) == 0
919 && addr
->transport_return
== PENDING_OK
923 done
= (options
& vopt_callout_fullpm
) != 0
924 && smtp_write_command(&sx
.outblock
, SCMD_FLUSH
,
925 "RCPT TO:<postmaster>\r\n") >= 0
926 && smtp_read_response(&sx
.inblock
, sx
.buffer
,
927 sizeof(sx
.buffer
), '2', callout
);
929 /* Sort out the cache record */
931 new_domain_record
.postmaster_stamp
= time(NULL
);
934 new_domain_record
.postmaster_result
= ccache_accept
;
935 else if (errno
== 0 && sx
.buffer
[0] == '5')
937 *failure_ptr
= US
"postmaster";
938 setflag(addr
, af_verify_pmfail
);
939 new_domain_record
.postmaster_result
= ccache_reject
;
942 addr
->address
= main_address
;
945 /* For any failure of the main check, other than a negative response, we just
946 close the connection and carry on. We can identify a negative response by the
947 fact that errno is zero. For I/O errors it will be non-zero
949 Set up different error texts for logging and for sending back to the caller
950 as an SMTP response. Log in all cases, using a one-line format. For sender
951 callouts, give a full response to the caller, but for recipient callouts,
952 don't give the IP address because this may be an internal host whose identity
953 is not to be widely broadcast. */
959 HDEBUG(D_verify
) debug_printf("SMTP timeout\n");
960 sx
.send_quit
= FALSE
;
966 extern int acl_where
; /* src/acl.c */
968 addr
->message
= string_sprintf(
969 "response to \"EHLO\" did not include SMTPUTF8");
970 addr
->user_message
= acl_where
== ACL_WHERE_RCPT
971 ? US
"533 no support for internationalised mailbox name"
972 : US
"550 mailbox unavailable";
979 sx
.send_quit
= FALSE
;
983 if (*sx
.buffer
== 0) Ustrcpy(sx
.buffer
, US
"connection dropped");
985 /*XXX test here is ugly; seem to have a split of responsibility for
986 building this message. Need to reationalise. Where is it done
987 before here, and when not?
988 Not == 5xx resp to MAIL on main-verify
990 if (!addr
->message
) addr
->message
=
991 string_sprintf("response to \"%s\" was: %s",
992 big_buffer
, string_printing(sx
.buffer
));
994 addr
->user_message
= options
& vopt_is_recipient
995 ? string_sprintf("Callout verification failed:\n%s", sx
.buffer
)
996 : string_sprintf("Called: %s\nSent: %s\nResponse: %s",
997 host
->address
, big_buffer
, sx
.buffer
);
999 /* Hard rejection ends the process */
1001 if (sx
.buffer
[0] == '5') /* Address rejected */
1009 /* End the SMTP conversation and close the connection. */
1011 /* Cutthrough - on a successful connect and recipient-verify with
1012 use-sender and we are 1st rcpt and have no cutthrough conn so far
1013 here is where we want to leave the conn open. Ditto for a lazy-close
1016 if ( (cutthrough
.delivery
|| options
& vopt_callout_hold
)
1020 && (options
& (vopt_callout_recipsender
|vopt_callout_recippmaster
|vopt_success_on_redirect
))
1021 == vopt_callout_recipsender
1022 && !random_local_part
1024 && cutthrough
.fd
< 0
1028 HDEBUG(D_acl
|D_v
) debug_printf_indent("holding verify callout open for %s\n",
1030 ? "cutthrough delivery" : "potential further verifies and delivery");
1032 cutthrough
.callout_hold_only
= !cutthrough
.delivery
;
1033 cutthrough
.is_tls
= tls_out
.active
>= 0;
1034 cutthrough
.fd
= sx
.outblock
.sock
; /* We assume no buffer in use in the outblock */
1035 cutthrough
.nrcpt
= 1;
1036 cutthrough
.transport
= addr
->transport
->name
;
1037 cutthrough
.interface
= interface
;
1038 cutthrough
.snd_port
= sending_port
;
1039 cutthrough
.peer_options
= smtp_peer_options
;
1040 cutthrough
.host
= *host
;
1042 int oldpool
= store_pool
;
1043 store_pool
= POOL_PERM
;
1044 cutthrough
.snd_ip
= string_copy(sending_ip_address
);
1045 cutthrough
.host
.name
= string_copy(host
->name
);
1046 cutthrough
.host
.address
= string_copy(host
->address
);
1047 store_pool
= oldpool
;
1049 cutthrough
.addr
= *addr
; /* Save the address_item for later logging */
1050 cutthrough
.addr
.next
= NULL
;
1051 cutthrough
.addr
.host_used
= &cutthrough
.host
;
1053 *(cutthrough
.addr
.parent
= store_get(sizeof(address_item
))) =
1055 ctblock
.buffer
= ctbuffer
;
1056 ctblock
.buffersize
= sizeof(ctbuffer
);
1057 ctblock
.ptr
= ctbuffer
;
1058 /* ctblock.cmd_count = 0; ctblock.authenticating = FALSE; */
1059 ctblock
.sock
= cutthrough
.fd
;
1063 /* Ensure no cutthrough on multiple verifies that were incompatible */
1064 if (options
& vopt_callout_recipsender
)
1065 cancel_cutthrough_connection(TRUE
, US
"not usable for cutthrough");
1068 (void) smtp_write_command(&sx
.outblock
, SCMD_FLUSH
, "QUIT\r\n");
1070 /* Wait a short time for response, and discard it */
1071 smtp_read_response(&sx
.inblock
, sx
.buffer
, sizeof(sx
.buffer
),
1075 if (sx
.inblock
.sock
>= 0)
1078 tls_close(FALSE
, TRUE
);
1080 HDEBUG(D_transport
|D_acl
|D_v
) debug_printf_indent(" SMTP(close)>>\n");
1081 (void)close(sx
.inblock
.sock
);
1082 sx
.inblock
.sock
= sx
.outblock
.sock
= -1;
1083 #ifndef DISABLE_EVENT
1084 (void) event_raise(addr
->transport
->event_action
, US
"tcp:close", NULL
);
1089 if (!done
|| yield
!= OK
)
1090 addr
->message
= string_sprintf("%s [%s] : %s", host
->name
, host
->address
,
1092 } /* Loop through all hosts, while !done */
1095 /* If we get here with done == TRUE, a successful callout happened, and yield
1096 will be set OK or FAIL according to the response to the RCPT command.
1097 Otherwise, we looped through the hosts but couldn't complete the business.
1098 However, there may be domain-specific information to cache in both cases. */
1100 if (!(options
& vopt_callout_no_cache
))
1101 cache_callout_write(&new_domain_record
, addr
->domain
,
1102 done
, &new_address_record
, address_key
);
1104 /* Failure to connect to any host, or any response other than 2xx or 5xx is a
1105 temporary error. If there was only one host, and a response was received, leave
1106 it alone if supplying details. Otherwise, give a generic response. */
1110 uschar
* dullmsg
= string_sprintf("Could not complete %s verify callout",
1111 options
& vopt_is_recipient
? "recipient" : "sender");
1114 addr
->message
= host_list
->next
|| !addr
->message
1115 ? dullmsg
: string_sprintf("%s: %s", dullmsg
, addr
->message
);
1117 addr
->user_message
= smtp_return_error_details
1118 ? string_sprintf("%s for <%s>.\n"
1119 "The mail server(s) for the domain may be temporarily unreachable, or\n"
1120 "they may be permanently unreachable from this server. In the latter case,\n%s",
1121 dullmsg
, addr
->address
,
1122 options
& vopt_is_recipient
1123 ? "the address will never be accepted."
1124 : "you need to change the address or create an MX record for its domain\n"
1125 "if it is supposed to be generally accessible from the Internet.\n"
1126 "Talk to your mail administrator for details.")
1129 /* Force a specific error code */
1131 addr
->basic_errno
= ERRNO_CALLOUTDEFER
;
1134 /* Come here from within the cache-reading code on fast-track exit. */
1137 tls_modify_variables(&tls_in
);
1143 /* Called after recipient-acl to get a cutthrough connection open when
1144 one was requested and a recipient-verify wasn't subsequently done.
1147 open_cutthrough_connection( address_item
* addr
)
1152 /* Use a recipient-verify-callout to set up the cutthrough connection. */
1153 /* We must use a copy of the address for verification, because it might
1157 HDEBUG(D_acl
) debug_printf_indent("----------- %s cutthrough setup ------------\n",
1158 rcpt_count
> 1 ? "more" : "start");
1159 rc
= verify_address(&addr2
, NULL
,
1160 vopt_is_recipient
| vopt_callout_recipsender
| vopt_callout_no_cache
,
1161 CUTTHROUGH_CMD_TIMEOUT
, -1, -1,
1163 addr
->message
= addr2
.message
;
1164 addr
->user_message
= addr2
.user_message
;
1165 HDEBUG(D_acl
) debug_printf_indent("----------- end cutthrough setup ------------\n");
1171 /* Send given number of bytes from the buffer */
1173 cutthrough_send(int n
)
1175 if(cutthrough
.fd
< 0)
1180 (tls_out
.active
== cutthrough
.fd
) ? tls_write(FALSE
, ctblock
.buffer
, n
) :
1182 send(cutthrough
.fd
, ctblock
.buffer
, n
, 0) > 0
1185 transport_count
+= n
;
1186 ctblock
.ptr
= ctblock
.buffer
;
1190 HDEBUG(D_transport
|D_acl
) debug_printf_indent("cutthrough_send failed: %s\n", strerror(errno
));
1197 _cutthrough_puts(uschar
* cp
, int n
)
1201 if(ctblock
.ptr
>= ctblock
.buffer
+ctblock
.buffersize
)
1202 if(!cutthrough_send(ctblock
.buffersize
))
1205 *ctblock
.ptr
++ = *cp
++;
1210 /* Buffered output of counted data block. Return boolean success */
1212 cutthrough_puts(uschar
* cp
, int n
)
1214 if (cutthrough
.fd
< 0) return TRUE
;
1215 if (_cutthrough_puts(cp
, n
)) return TRUE
;
1216 cancel_cutthrough_connection(TRUE
, US
"transmit failed");
1221 cutthrough_data_puts(uschar
* cp
, int n
)
1223 if (cutthrough
.delivery
) (void) cutthrough_puts(cp
, n
);
1229 _cutthrough_flush_send(void)
1231 int n
= ctblock
.ptr
- ctblock
.buffer
;
1234 if(!cutthrough_send(n
))
1240 /* Send out any bufferred output. Return boolean success. */
1242 cutthrough_flush_send(void)
1244 if (_cutthrough_flush_send()) return TRUE
;
1245 cancel_cutthrough_connection(TRUE
, US
"transmit failed");
1251 cutthrough_put_nl(void)
1253 return cutthrough_puts(US
"\r\n", 2);
1258 cutthrough_data_put_nl(void)
1260 cutthrough_data_puts(US
"\r\n", 2);
1264 /* Get and check response from cutthrough target */
1266 cutthrough_response(int fd
, char expect
, uschar
** copy
, int timeout
)
1268 smtp_inblock inblock
;
1269 uschar inbuffer
[4096];
1270 uschar responsebuffer
[4096];
1272 inblock
.buffer
= inbuffer
;
1273 inblock
.buffersize
= sizeof(inbuffer
);
1274 inblock
.ptr
= inbuffer
;
1275 inblock
.ptrend
= inbuffer
;
1277 /* this relies on (inblock.sock == tls_out.active) */
1278 if(!smtp_read_response(&inblock
, responsebuffer
, sizeof(responsebuffer
), expect
, timeout
))
1279 cancel_cutthrough_connection(TRUE
, US
"target timeout on read");
1284 *copy
= cp
= string_copy(responsebuffer
);
1285 /* Trim the trailing end of line */
1286 cp
+= Ustrlen(responsebuffer
);
1287 if(cp
> *copy
&& cp
[-1] == '\n') *--cp
= '\0';
1288 if(cp
> *copy
&& cp
[-1] == '\r') *--cp
= '\0';
1291 return responsebuffer
[0];
1295 /* Negotiate dataphase with the cutthrough target, returning success boolean */
1297 cutthrough_predata(void)
1299 if(cutthrough
.fd
< 0 || cutthrough
.callout_hold_only
)
1302 HDEBUG(D_transport
|D_acl
|D_v
) debug_printf_indent(" SMTP>> DATA\n");
1303 cutthrough_puts(US
"DATA\r\n", 6);
1304 cutthrough_flush_send();
1306 /* Assume nothing buffered. If it was it gets ignored. */
1307 return cutthrough_response(cutthrough
.fd
, '3', NULL
, CUTTHROUGH_DATA_TIMEOUT
) == '3';
1311 /* tctx arg only to match write_chunk() */
1313 cutthrough_write_chunk(transport_ctx
* tctx
, uschar
* s
, int len
)
1316 while(s
&& (s2
= Ustrchr(s
, '\n')))
1318 if(!cutthrough_puts(s
, s2
-s
) || !cutthrough_put_nl())
1326 /* Buffered send of headers. Return success boolean. */
1327 /* Expands newlines to wire format (CR,NL). */
1328 /* Also sends header-terminating blank line. */
1330 cutthrough_headers_send(void)
1334 if(cutthrough
.fd
< 0 || cutthrough
.callout_hold_only
)
1337 /* We share a routine with the mainline transport to handle header add/remove/rewrites,
1338 but having a separate buffered-output function (for now)
1340 HDEBUG(D_acl
) debug_printf_indent("----------- start cutthrough headers send -----------\n");
1342 tctx
.u
.fd
= cutthrough
.fd
;
1343 tctx
.tblock
= cutthrough
.addr
.transport
;
1344 tctx
.addr
= &cutthrough
.addr
;
1345 tctx
.check_string
= US
".";
1346 tctx
.escape_string
= US
"..";
1347 tctx
.options
= topt_use_crlf
;
1349 if (!transport_headers_send(&tctx
, &cutthrough_write_chunk
))
1352 HDEBUG(D_acl
) debug_printf_indent("----------- done cutthrough headers send ------------\n");
1358 close_cutthrough_connection(const uschar
* why
)
1360 int fd
= cutthrough
.fd
;
1363 /* We could be sending this after a bunch of data, but that is ok as
1364 the only way to cancel the transfer in dataphase is to drop the tcp
1365 conn before the final dot.
1367 ctblock
.ptr
= ctbuffer
;
1368 HDEBUG(D_transport
|D_acl
|D_v
) debug_printf_indent(" SMTP>> QUIT\n");
1369 _cutthrough_puts(US
"QUIT\r\n", 6); /* avoid recursion */
1370 _cutthrough_flush_send();
1371 cutthrough
.fd
= -1; /* avoid recursion via read timeout */
1373 /* Wait a short time for response, and discard it */
1374 cutthrough_response(fd
, '2', NULL
, 1);
1377 tls_close(FALSE
, TRUE
);
1379 HDEBUG(D_transport
|D_acl
|D_v
) debug_printf_indent(" SMTP(close)>>\n");
1381 HDEBUG(D_acl
) debug_printf_indent("----------- cutthrough shutdown (%s) ------------\n", why
);
1383 ctblock
.ptr
= ctbuffer
;
1387 cancel_cutthrough_connection(BOOL close_noncutthrough_verifies
, const uschar
* why
)
1389 if (cutthrough
.delivery
|| close_noncutthrough_verifies
)
1390 close_cutthrough_connection(why
);
1391 cutthrough
.delivery
= cutthrough
.callout_hold_only
= FALSE
;
1396 release_cutthrough_connection(const uschar
* why
)
1398 HDEBUG(D_acl
) debug_printf_indent("release cutthrough conn: %s\n", why
);
1400 cutthrough
.delivery
= cutthrough
.callout_hold_only
= FALSE
;
1406 /* Have senders final-dot. Send one to cutthrough target, and grab the response.
1407 Log an OK response as a transmission.
1408 Close the connection.
1409 Return smtp response-class digit.
1412 cutthrough_finaldot(void)
1415 address_item
* addr
;
1416 HDEBUG(D_transport
|D_acl
|D_v
) debug_printf_indent(" SMTP>> .\n");
1418 /* Assume data finshed with new-line */
1419 if( !cutthrough_puts(US
".", 1)
1420 || !cutthrough_put_nl()
1421 || !cutthrough_flush_send()
1423 return cutthrough
.addr
.message
;
1425 res
= cutthrough_response(cutthrough
.fd
, '2', &cutthrough
.addr
.message
, CUTTHROUGH_DATA_TIMEOUT
);
1426 for (addr
= &cutthrough
.addr
; addr
; addr
= addr
->next
)
1428 addr
->message
= cutthrough
.addr
.message
;
1432 delivery_log(LOG_MAIN
, addr
, (int)'>', NULL
);
1433 close_cutthrough_connection(US
"delivered");
1437 delivery_log(LOG_MAIN
, addr
, 0,
1438 US
"tmp-reject from cutthrough after DATA:");
1442 delivery_log(LOG_MAIN
|LOG_REJECT
, addr
, 0,
1443 US
"rejected after DATA:");
1450 return cutthrough
.addr
.message
;
1455 /*************************************************
1456 * Copy error to toplevel address *
1457 *************************************************/
1459 /* This function is used when a verify fails or defers, to ensure that the
1460 failure or defer information is in the original toplevel address. This applies
1461 when an address is redirected to a single new address, and the failure or
1462 deferral happens to the child address.
1465 vaddr the verify address item
1466 addr the final address item
1469 Returns: the value of YIELD
1473 copy_error(address_item
*vaddr
, address_item
*addr
, int yield
)
1477 vaddr
->message
= addr
->message
;
1478 vaddr
->user_message
= addr
->user_message
;
1479 vaddr
->basic_errno
= addr
->basic_errno
;
1480 vaddr
->more_errno
= addr
->more_errno
;
1481 vaddr
->prop
.address_data
= addr
->prop
.address_data
;
1482 copyflag(vaddr
, addr
, af_pass_message
);
1490 /**************************************************
1491 * printf that automatically handles TLS if needed *
1492 ***************************************************/
1494 /* This function is used by verify_address() as a substitute for all fprintf()
1495 calls; a direct fprintf() will not produce output in a TLS SMTP session, such
1496 as a response to an EXPN command. smtp_in.c makes smtp_printf available but
1497 that assumes that we always use the smtp_out FILE* when not using TLS or the
1498 ssl buffer when we are. Instead we take a FILE* parameter and check to see if
1499 that is smtp_out; if so, smtp_printf() with TLS support, otherwise regular
1503 f the candidate FILE* to write to
1504 format format string
1505 ... optional arguments
1511 static void PRINTF_FUNCTION(2,3)
1512 respond_printf(FILE *f
, const char *format
, ...)
1516 va_start(ap
, format
);
1517 if (smtp_out
&& (f
== smtp_out
))
1518 smtp_vprintf(format
, ap
);
1520 vfprintf(f
, format
, ap
);
1526 /*************************************************
1527 * Verify an email address *
1528 *************************************************/
1530 /* This function is used both for verification (-bv and at other times) and
1531 address testing (-bt), which is indicated by address_test_mode being set.
1534 vaddr contains the address to verify; the next field in this block
1536 f if not NULL, write the result to this file
1537 options various option bits:
1538 vopt_fake_sender => this sender verify is not for the real
1539 sender (it was verify=sender=xxxx or an address from a
1540 header line) - rewriting must not change sender_address
1541 vopt_is_recipient => this is a recipient address, otherwise
1542 it's a sender address - this affects qualification and
1543 rewriting and messages from callouts
1544 vopt_qualify => qualify an unqualified address; else error
1545 vopt_expn => called from SMTP EXPN command
1546 vopt_success_on_redirect => when a new address is generated
1547 the verification instantly succeeds
1549 These ones are used by do_callout() -- the options variable
1552 vopt_callout_fullpm => if postmaster check, do full one
1553 vopt_callout_no_cache => don't use callout cache
1554 vopt_callout_random => do the "random" thing
1555 vopt_callout_recipsender => use real sender for recipient
1556 vopt_callout_recippmaster => use postmaster for recipient
1558 callout if > 0, specifies that callout is required, and gives timeout
1559 for individual commands
1560 callout_overall if > 0, gives overall timeout for the callout function;
1561 if < 0, a default is used (see do_callout())
1562 callout_connect the connection timeout for callouts
1563 se_mailfrom when callout is requested to verify a sender, use this
1564 in MAIL FROM; NULL => ""
1565 pm_mailfrom when callout is requested, if non-NULL, do the postmaster
1566 thing and use this as the sender address (may be "")
1568 routed if not NULL, set TRUE if routing succeeded, so we can
1569 distinguish between routing failed and callout failed
1571 Returns: OK address verified
1572 FAIL address failed to verify
1573 DEFER can't tell at present
1577 verify_address(address_item
*vaddr
, FILE *f
, int options
, int callout
,
1578 int callout_overall
, int callout_connect
, uschar
*se_mailfrom
,
1579 uschar
*pm_mailfrom
, BOOL
*routed
)
1582 BOOL full_info
= (f
== NULL
)? FALSE
: (debug_selector
!= 0);
1583 BOOL expn
= (options
& vopt_expn
) != 0;
1584 BOOL success_on_redirect
= (options
& vopt_success_on_redirect
) != 0;
1587 int verify_type
= expn
? v_expn
:
1588 address_test_mode
? v_none
:
1589 options
& vopt_is_recipient
? v_recipient
: v_sender
;
1590 address_item
*addr_list
;
1591 address_item
*addr_new
= NULL
;
1592 address_item
*addr_remote
= NULL
;
1593 address_item
*addr_local
= NULL
;
1594 address_item
*addr_succeed
= NULL
;
1595 uschar
**failure_ptr
= options
& vopt_is_recipient
1596 ? &recipient_verify_failure
: &sender_verify_failure
;
1597 uschar
*ko_prefix
, *cr
;
1598 uschar
*address
= vaddr
->address
;
1599 uschar
*save_sender
;
1600 uschar null_sender
[] = { 0 }; /* Ensure writeable memory */
1602 /* Clear, just in case */
1604 *failure_ptr
= NULL
;
1606 /* Set up a prefix and suffix for error message which allow us to use the same
1607 output statements both in EXPN mode (where an SMTP response is needed) and when
1608 debugging with an output file. */
1612 ko_prefix
= US
"553 ";
1615 else ko_prefix
= cr
= US
"";
1617 /* Add qualify domain if permitted; otherwise an unqualified address fails. */
1619 if (parse_find_at(address
) == NULL
)
1621 if ((options
& vopt_qualify
) == 0)
1624 respond_printf(f
, "%sA domain is required for \"%s\"%s\n",
1625 ko_prefix
, address
, cr
);
1626 *failure_ptr
= US
"qualify";
1629 address
= rewrite_address_qualify(address
, options
& vopt_is_recipient
);
1634 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
1635 debug_printf("%s %s\n", address_test_mode
? "Testing" : "Verifying", address
);
1638 /* Rewrite and report on it. Clear the domain and local part caches - these
1639 may have been set by domains and local part tests during an ACL. */
1641 if (global_rewrite_rules
!= NULL
)
1643 uschar
*old
= address
;
1644 address
= rewrite_address(address
, options
& vopt_is_recipient
, FALSE
,
1645 global_rewrite_rules
, rewrite_existflags
);
1648 for (i
= 0; i
< (MAX_NAMED_LIST
* 2)/32; i
++) vaddr
->localpart_cache
[i
] = 0;
1649 for (i
= 0; i
< (MAX_NAMED_LIST
* 2)/32; i
++) vaddr
->domain_cache
[i
] = 0;
1650 if (f
!= NULL
&& !expn
) fprintf(f
, "Address rewritten as: %s\n", address
);
1654 /* If this is the real sender address, we must update sender_address at
1655 this point, because it may be referred to in the routers. */
1657 if ((options
& (vopt_fake_sender
|vopt_is_recipient
)) == 0)
1658 sender_address
= address
;
1660 /* If the address was rewritten to <> no verification can be done, and we have
1661 to return OK. This rewriting is permitted only for sender addresses; for other
1662 addresses, such rewriting fails. */
1664 if (address
[0] == 0) return OK
;
1666 /* Flip the legacy TLS-related variables over to the outbound set in case
1667 they're used in the context of a transport used by verification. Reset them
1668 at exit from this routine (so no returns allowed from here on). */
1670 tls_modify_variables(&tls_out
);
1672 /* Save a copy of the sender address for re-instating if we change it to <>
1673 while verifying a sender address (a nice bit of self-reference there). */
1675 save_sender
= sender_address
;
1677 /* Observability variable for router/transport use */
1679 verify_mode
= options
& vopt_is_recipient
? US
"R" : US
"S";
1681 /* Update the address structure with the possibly qualified and rewritten
1682 address. Set it up as the starting address on the chain of new addresses. */
1684 vaddr
->address
= address
;
1687 /* We need a loop, because an address can generate new addresses. We must also
1688 cope with generated pipes and files at the top level. (See also the code and
1689 comment in deliver.c.) However, it is usually the case that the router for
1690 user's .forward files has its verify flag turned off.
1692 If an address generates more than one child, the loop is used only when
1693 full_info is set, and this can only be set locally. Remote enquiries just get
1694 information about the top level address, not anything that it generated. */
1699 address_item
*addr
= addr_new
;
1701 addr_new
= addr
->next
;
1706 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
1707 debug_printf("Considering %s\n", addr
->address
);
1710 /* Handle generated pipe, file or reply addresses. We don't get these
1711 when handling EXPN, as it does only one level of expansion. */
1713 if (testflag(addr
, af_pfr
))
1720 if (addr
->address
[0] == '>')
1722 allow
= testflag(addr
, af_allow_reply
);
1723 fprintf(f
, "%s -> mail %s", addr
->parent
->address
, addr
->address
+ 1);
1727 allow
= (addr
->address
[0] == '|')?
1728 testflag(addr
, af_allow_pipe
) : testflag(addr
, af_allow_file
);
1729 fprintf(f
, "%s -> %s", addr
->parent
->address
, addr
->address
);
1732 if (addr
->basic_errno
== ERRNO_BADTRANSPORT
)
1733 fprintf(f
, "\n*** Error in setting up pipe, file, or autoreply:\n"
1734 "%s\n", addr
->message
);
1736 fprintf(f
, "\n transport = %s\n", addr
->transport
->name
);
1738 fprintf(f
, " *** forbidden ***\n");
1743 /* Just in case some router parameter refers to it. */
1745 return_path
= addr
->prop
.errors_address
1746 ? addr
->prop
.errors_address
: sender_address
;
1748 /* Split the address into domain and local part, handling the %-hack if
1749 necessary, and then route it. While routing a sender address, set
1750 $sender_address to <> because that is what it will be if we were trying to
1751 send a bounce to the sender. */
1753 if (routed
) *routed
= FALSE
;
1754 if ((rc
= deliver_split_address(addr
)) == OK
)
1756 if (!(options
& vopt_is_recipient
)) sender_address
= null_sender
;
1757 rc
= route_address(addr
, &addr_local
, &addr_remote
, &addr_new
,
1758 &addr_succeed
, verify_type
);
1759 sender_address
= save_sender
; /* Put back the real sender */
1762 /* If routing an address succeeded, set the flag that remembers, for use when
1763 an ACL cached a sender verify (in case a callout fails). Then if routing set
1764 up a list of hosts or the transport has a host list, and the callout option
1765 is set, and we aren't in a host checking run, do the callout verification,
1766 and set another flag that notes that a callout happened. */
1770 if (routed
) *routed
= TRUE
;
1773 transport_instance
* tp
;
1774 host_item
* host_list
= addr
->host_list
;
1776 /* Make up some data for use in the case where there is no remote
1779 transport_feedback tf
= {
1780 NULL
, /* interface (=> any) */
1781 US
"smtp", /* port */
1782 US
"smtp", /* protocol */
1784 US
"$smtp_active_hostname", /* helo_data */
1785 FALSE
, /* hosts_override */
1786 FALSE
, /* hosts_randomize */
1787 FALSE
, /* gethostbyname */
1788 TRUE
, /* qualify_single */
1789 FALSE
/* search_parents */
1792 /* If verification yielded a remote transport, we want to use that
1793 transport's options, so as to mimic what would happen if we were really
1794 sending a message to this address. */
1796 if ((tp
= addr
->transport
) && !tp
->info
->local
)
1798 (void)(tp
->setup
)(tp
, addr
, &tf
, 0, 0, NULL
);
1800 /* If the transport has hosts and the router does not, or if the
1801 transport is configured to override the router's hosts, we must build a
1802 host list of the transport's hosts, and find the IP addresses */
1804 if (tf
.hosts
&& (!host_list
|| tf
.hosts_override
))
1807 const uschar
*save_deliver_domain
= deliver_domain
;
1808 uschar
*save_deliver_localpart
= deliver_localpart
;
1810 host_list
= NULL
; /* Ignore the router's hosts */
1812 deliver_domain
= addr
->domain
;
1813 deliver_localpart
= addr
->local_part
;
1814 s
= expand_string(tf
.hosts
);
1815 deliver_domain
= save_deliver_domain
;
1816 deliver_localpart
= save_deliver_localpart
;
1820 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to expand list of hosts "
1821 "\"%s\" in %s transport for callout: %s", tf
.hosts
,
1822 tp
->name
, expand_string_message
);
1827 host_item
*host
, *nexthost
;
1828 host_build_hostlist(&host_list
, s
, tf
.hosts_randomize
);
1830 /* Just ignore failures to find a host address. If we don't manage
1831 to find any addresses, the callout will defer. Note that more than
1832 one address may be found for a single host, which will result in
1833 additional host items being inserted into the chain. Hence we must
1834 save the next host first. */
1836 flags
= HOST_FIND_BY_A
;
1837 if (tf
.qualify_single
) flags
|= HOST_FIND_QUALIFY_SINGLE
;
1838 if (tf
.search_parents
) flags
|= HOST_FIND_SEARCH_PARENTS
;
1840 for (host
= host_list
; host
; host
= nexthost
)
1842 nexthost
= host
->next
;
1843 if (tf
.gethostbyname
||
1844 string_is_ip_address(host
->name
, NULL
) != 0)
1845 (void)host_find_byname(host
, NULL
, flags
, NULL
, TRUE
);
1848 dnssec_domains
* dnssec_domains
= NULL
;
1849 if (Ustrcmp(tp
->driver_name
, "smtp") == 0)
1851 smtp_transport_options_block
* ob
=
1852 (smtp_transport_options_block
*) tp
->options_block
;
1853 dnssec_domains
= &ob
->dnssec
;
1856 (void) host_find_bydns(host
, NULL
, flags
, NULL
, NULL
, NULL
,
1857 dnssec_domains
, NULL
, NULL
);
1864 /* Can only do a callout if we have at least one host! If the callout
1865 fails, it will have set ${sender,recipient}_verify_failure. */
1869 HDEBUG(D_verify
) debug_printf("Attempting full verification using callout\n");
1870 if (host_checking
&& !host_checking_callout
)
1873 debug_printf("... callout omitted by default when host testing\n"
1874 "(Use -bhc if you want the callouts to happen.)\n");
1879 deliver_set_expansions(addr
);
1881 rc
= do_callout(addr
, host_list
, &tf
, callout
, callout_overall
,
1882 callout_connect
, options
, se_mailfrom
, pm_mailfrom
);
1887 HDEBUG(D_verify
) debug_printf("Cannot do callout: neither router nor "
1888 "transport provided a host list\n");
1893 /* Otherwise, any failure is a routing failure */
1895 else *failure_ptr
= US
"route";
1897 /* A router may return REROUTED if it has set up a child address as a result
1898 of a change of domain name (typically from widening). In this case we always
1899 want to continue to verify the new child. */
1901 if (rc
== REROUTED
) continue;
1903 /* Handle hard failures */
1910 address_item
*p
= addr
->parent
;
1912 respond_printf(f
, "%s%s %s", ko_prefix
,
1913 full_info
? addr
->address
: address
,
1914 address_test_mode
? "is undeliverable" : "failed to verify");
1915 if (!expn
&& admin_user
)
1917 if (addr
->basic_errno
> 0)
1918 respond_printf(f
, ": %s", strerror(addr
->basic_errno
));
1920 respond_printf(f
, ": %s", addr
->message
);
1923 /* Show parents iff doing full info */
1925 if (full_info
) while (p
)
1927 respond_printf(f
, "%s\n <-- %s", cr
, p
->address
);
1930 respond_printf(f
, "%s\n", cr
);
1932 cancel_cutthrough_connection(TRUE
, US
"routing hard fail");
1936 yield
= copy_error(vaddr
, addr
, FAIL
);
1944 else if (rc
== DEFER
)
1949 address_item
*p
= addr
->parent
;
1950 respond_printf(f
, "%s%s cannot be resolved at this time", ko_prefix
,
1951 full_info
? addr
->address
: address
);
1952 if (!expn
&& admin_user
)
1954 if (addr
->basic_errno
> 0)
1955 respond_printf(f
, ": %s", strerror(addr
->basic_errno
));
1957 respond_printf(f
, ": %s", addr
->message
);
1958 else if (addr
->basic_errno
<= 0)
1959 respond_printf(f
, ": unknown error");
1962 /* Show parents iff doing full info */
1964 if (full_info
) while (p
)
1966 respond_printf(f
, "%s\n <-- %s", cr
, p
->address
);
1969 respond_printf(f
, "%s\n", cr
);
1971 cancel_cutthrough_connection(TRUE
, US
"routing soft fail");
1975 yield
= copy_error(vaddr
, addr
, DEFER
);
1978 if (yield
== OK
) yield
= DEFER
;
1981 /* If we are handling EXPN, we do not want to continue to route beyond
1982 the top level (whose address is in "address"). */
1986 uschar
*ok_prefix
= US
"250-";
1989 if (!addr_local
&& !addr_remote
)
1990 respond_printf(f
, "250 mail to <%s> is discarded\r\n", address
);
1992 respond_printf(f
, "250 <%s>\r\n", address
);
1996 address_item
*addr2
= addr_new
;
1997 addr_new
= addr2
->next
;
1998 if (!addr_new
) ok_prefix
= US
"250 ";
1999 respond_printf(f
, "%s<%s>\r\n", ok_prefix
, addr2
->address
);
2005 /* Successful routing other than EXPN. */
2009 /* Handle successful routing when short info wanted. Otherwise continue for
2010 other (generated) addresses. Short info is the operational case. Full info
2011 can be requested only when debug_selector != 0 and a file is supplied.
2013 There is a conflict between the use of aliasing as an alternate email
2014 address, and as a sort of mailing list. If an alias turns the incoming
2015 address into just one address (e.g. J.Caesar->jc44) you may well want to
2016 carry on verifying the generated address to ensure it is valid when
2017 checking incoming mail. If aliasing generates multiple addresses, you
2018 probably don't want to do this. Exim therefore treats the generation of
2019 just a single new address as a special case, and continues on to verify the
2020 generated address. */
2022 if ( !full_info
/* Stop if short info wanted AND */
2023 && ( ( !addr_new
/* No new address OR */
2024 || addr_new
->next
/* More than one new address OR */
2025 || testflag(addr_new
, af_pfr
) /* New address is pfr */
2028 ( addr_new
/* At least one new address AND */
2029 && success_on_redirect
/* success_on_redirect is set */
2033 if (f
) fprintf(f
, "%s %s\n",
2034 address
, address_test_mode
? "is deliverable" : "verified");
2036 /* If we have carried on to verify a child address, we want the value
2037 of $address_data to be that of the child */
2039 vaddr
->prop
.address_data
= addr
->prop
.address_data
;
2041 /* If stopped because more than one new address, cannot cutthrough */
2043 if (addr_new
&& addr_new
->next
)
2044 cancel_cutthrough_connection(TRUE
, US
"multiple addresses from routing");
2050 } /* Loop for generated addresses */
2052 /* Display the full results of the successful routing, including any generated
2053 addresses. Control gets here only when full_info is set, which requires f not
2054 to be NULL, and this occurs only when a top-level verify is called with the
2055 debugging switch on.
2057 If there are no local and no remote addresses, and there were no pipes, files,
2058 or autoreplies, and there were no errors or deferments, the message is to be
2059 discarded, usually because of the use of :blackhole: in an alias file. */
2061 if (allok
&& !addr_local
&& !addr_remote
)
2063 fprintf(f
, "mail to %s is discarded\n", address
);
2067 for (addr_list
= addr_local
, i
= 0; i
< 2; addr_list
= addr_remote
, i
++)
2070 address_item
*addr
= addr_list
;
2071 address_item
*p
= addr
->parent
;
2072 transport_instance
* tp
= addr
->transport
;
2074 addr_list
= addr
->next
;
2076 fprintf(f
, "%s", CS addr
->address
);
2077 #ifdef EXPERIMENTAL_SRS
2078 if(addr
->prop
.srs_sender
)
2079 fprintf(f
, " [srs = %s]", addr
->prop
.srs_sender
);
2082 /* If the address is a duplicate, show something about it. */
2084 if (!testflag(addr
, af_pfr
))
2087 if ((tnode
= tree_search(tree_duplicates
, addr
->unique
)))
2088 fprintf(f
, " [duplicate, would not be delivered]");
2089 else tree_add_duplicate(addr
->unique
, addr
);
2092 /* Now show its parents */
2094 for (p
= addr
->parent
; p
; p
= p
->parent
)
2095 fprintf(f
, "\n <-- %s", p
->address
);
2098 /* Show router, and transport */
2100 fprintf(f
, "router = %s, transport = %s\n",
2101 addr
->router
->name
, tp
? tp
->name
: US
"unset");
2103 /* Show any hosts that are set up by a router unless the transport
2104 is going to override them; fiddle a bit to get a nice format. */
2106 if (addr
->host_list
&& tp
&& !tp
->overrides_hosts
)
2111 for (h
= addr
->host_list
; h
; h
= h
->next
)
2112 { /* get max lengths of host names, addrs */
2113 int len
= Ustrlen(h
->name
);
2114 if (len
> maxlen
) maxlen
= len
;
2115 len
= h
->address
? Ustrlen(h
->address
) : 7;
2116 if (len
> maxaddlen
) maxaddlen
= len
;
2118 for (h
= addr
->host_list
; h
; h
= h
->next
)
2120 fprintf(f
, " host %-*s ", maxlen
, h
->name
);
2123 fprintf(f
, "[%s%-*c", h
->address
, maxaddlen
+1 - Ustrlen(h
->address
), ']');
2124 else if (tp
->info
->local
)
2125 fprintf(f
, " %-*s ", maxaddlen
, ""); /* Omit [unknown] for local */
2127 fprintf(f
, "[%s%-*c", "unknown", maxaddlen
+1 - 7, ']');
2129 if (h
->mx
>= 0) fprintf(f
, " MX=%d", h
->mx
);
2130 if (h
->port
!= PORT_NONE
) fprintf(f
, " port=%d", h
->port
);
2131 if (running_in_test_harness
&& h
->dnssec
== DS_YES
) fputs(" AD", f
);
2132 if (h
->status
== hstatus_unusable
) fputs(" ** unusable **", f
);
2138 /* Yield will be DEFER or FAIL if any one address has, only for full_info (which is
2139 the -bv or -bt case). */
2143 tls_modify_variables(&tls_in
);
2151 /*************************************************
2152 * Check headers for syntax errors *
2153 *************************************************/
2155 /* This function checks those header lines that contain addresses, and verifies
2156 that all the addresses therein are syntactially correct.
2159 msgptr where to put an error message
2166 verify_check_headers(uschar
**msgptr
)
2172 for (h
= header_list
; h
!= NULL
&& yield
== OK
; h
= h
->next
)
2174 if (h
->type
!= htype_from
&&
2175 h
->type
!= htype_reply_to
&&
2176 h
->type
!= htype_sender
&&
2177 h
->type
!= htype_to
&&
2178 h
->type
!= htype_cc
&&
2179 h
->type
!= htype_bcc
)
2182 colon
= Ustrchr(h
->text
, ':');
2184 while (isspace(*s
)) s
++;
2186 /* Loop for multiple addresses in the header, enabling group syntax. Note
2187 that we have to reset this after the header has been scanned. */
2189 parse_allow_group
= TRUE
;
2193 uschar
*ss
= parse_find_address_end(s
, FALSE
);
2194 uschar
*recipient
, *errmess
;
2195 int terminator
= *ss
;
2196 int start
, end
, domain
;
2198 /* Temporarily terminate the string at this point, and extract the
2199 operative address within, allowing group syntax. */
2202 recipient
= parse_extract_address(s
,&errmess
,&start
,&end
,&domain
,FALSE
);
2205 /* Permit an unqualified address only if the message is local, or if the
2206 sending host is configured to be permitted to send them. */
2208 if (recipient
!= NULL
&& domain
== 0)
2210 if (h
->type
== htype_from
|| h
->type
== htype_sender
)
2212 if (!allow_unqualified_sender
) recipient
= NULL
;
2216 if (!allow_unqualified_recipient
) recipient
= NULL
;
2218 if (recipient
== NULL
) errmess
= US
"unqualified address not permitted";
2221 /* It's an error if no address could be extracted, except for the special
2222 case of an empty address. */
2224 if (recipient
== NULL
&& Ustrcmp(errmess
, "empty address") != 0)
2226 uschar
*verb
= US
"is";
2231 /* Arrange not to include any white space at the end in the
2232 error message or the header name. */
2234 while (t
> s
&& isspace(t
[-1])) t
--;
2235 while (tt
> h
->text
&& isspace(tt
[-1])) tt
--;
2237 /* Add the address that failed to the error message, since in a
2238 header with very many addresses it is sometimes hard to spot
2239 which one is at fault. However, limit the amount of address to
2240 quote - cases have been seen where, for example, a missing double
2241 quote in a humungous To: header creates an "address" that is longer
2242 than string_sprintf can handle. */
2251 /* deconst cast ok as we're passing a non-const to string_printing() */
2252 *msgptr
= US
string_printing(
2253 string_sprintf("%s: failing address in \"%.*s:\" header %s: %.*s",
2254 errmess
, tt
- h
->text
, h
->text
, verb
, len
, s
));
2257 break; /* Out of address loop */
2260 /* Advance to the next address */
2262 s
= ss
+ (terminator
? 1:0);
2263 while (isspace(*s
)) s
++;
2264 } /* Next address */
2266 parse_allow_group
= FALSE
;
2267 parse_found_group
= FALSE
;
2268 } /* Next header unless yield has been set FALSE */
2274 /*************************************************
2275 * Check header names for 8-bit characters *
2276 *************************************************/
2278 /* This function checks for invalid characters in header names. See
2279 RFC 5322, 2.2. and RFC 6532, 3.
2282 msgptr where to put an error message
2289 verify_check_header_names_ascii(uschar
**msgptr
)
2294 for (h
= header_list
; h
; h
= h
->next
)
2296 colon
= Ustrchr(h
->text
, ':');
2297 for(s
= h
->text
; s
< colon
; s
++)
2298 if ((*s
< 33) || (*s
> 126))
2300 *msgptr
= string_sprintf("Invalid character in header \"%.*s\" found",
2301 colon
- h
->text
, h
->text
);
2308 /*************************************************
2309 * Check for blind recipients *
2310 *************************************************/
2312 /* This function checks that every (envelope) recipient is mentioned in either
2313 the To: or Cc: header lines, thus detecting blind carbon copies.
2315 There are two ways of scanning that could be used: either scan the header lines
2316 and tick off the recipients, or scan the recipients and check the header lines.
2317 The original proposed patch did the former, but I have chosen to do the latter,
2318 because (a) it requires no memory and (b) will use fewer resources when there
2319 are many addresses in To: and/or Cc: and only one or two envelope recipients.
2322 Returns: OK if there are no blind recipients
2323 FAIL if there is at least one blind recipient
2327 verify_check_notblind(void)
2330 for (i
= 0; i
< recipients_count
; i
++)
2334 uschar
*address
= recipients_list
[i
].address
;
2336 for (h
= header_list
; !found
&& h
!= NULL
; h
= h
->next
)
2340 if (h
->type
!= htype_to
&& h
->type
!= htype_cc
) continue;
2342 colon
= Ustrchr(h
->text
, ':');
2344 while (isspace(*s
)) s
++;
2346 /* Loop for multiple addresses in the header, enabling group syntax. Note
2347 that we have to reset this after the header has been scanned. */
2349 parse_allow_group
= TRUE
;
2353 uschar
*ss
= parse_find_address_end(s
, FALSE
);
2354 uschar
*recipient
,*errmess
;
2355 int terminator
= *ss
;
2356 int start
, end
, domain
;
2358 /* Temporarily terminate the string at this point, and extract the
2359 operative address within, allowing group syntax. */
2362 recipient
= parse_extract_address(s
,&errmess
,&start
,&end
,&domain
,FALSE
);
2365 /* If we found a valid recipient that has a domain, compare it with the
2366 envelope recipient. Local parts are compared case-sensitively, domains
2367 case-insensitively. By comparing from the start with length "domain", we
2368 include the "@" at the end, which ensures that we are comparing the whole
2369 local part of each address. */
2371 if (recipient
!= NULL
&& domain
!= 0)
2373 found
= Ustrncmp(recipient
, address
, domain
) == 0 &&
2374 strcmpic(recipient
+ domain
, address
+ domain
) == 0;
2378 /* Advance to the next address */
2380 s
= ss
+ (terminator
? 1:0);
2381 while (isspace(*s
)) s
++;
2382 } /* Next address */
2384 parse_allow_group
= FALSE
;
2385 parse_found_group
= FALSE
;
2386 } /* Next header (if found is false) */
2388 if (!found
) return FAIL
;
2389 } /* Next recipient */
2396 /*************************************************
2397 * Find if verified sender *
2398 *************************************************/
2400 /* Usually, just a single address is verified as the sender of the message.
2401 However, Exim can be made to verify other addresses as well (often related in
2402 some way), and this is useful in some environments. There may therefore be a
2403 chain of such addresses that have previously been tested. This function finds
2404 whether a given address is on the chain.
2406 Arguments: the address to be verified
2407 Returns: pointer to an address item, or NULL
2411 verify_checked_sender(uschar
*sender
)
2414 for (addr
= sender_verified_list
; addr
!= NULL
; addr
= addr
->next
)
2415 if (Ustrcmp(sender
, addr
->address
) == 0) break;
2423 /*************************************************
2424 * Get valid header address *
2425 *************************************************/
2427 /* Scan the originator headers of the message, looking for an address that
2428 verifies successfully. RFC 822 says:
2430 o The "Sender" field mailbox should be sent notices of
2431 any problems in transport or delivery of the original
2432 messages. If there is no "Sender" field, then the
2433 "From" field mailbox should be used.
2435 o If the "Reply-To" field exists, then the reply should
2436 go to the addresses indicated in that field and not to
2437 the address(es) indicated in the "From" field.
2439 So we check a Sender field if there is one, else a Reply_to field, else a From
2440 field. As some strange messages may have more than one of these fields,
2441 especially if they are resent- fields, check all of them if there is more than
2445 user_msgptr points to where to put a user error message
2446 log_msgptr points to where to put a log error message
2447 callout timeout for callout check (passed to verify_address())
2448 callout_overall overall callout timeout (ditto)
2449 callout_connect connect callout timeout (ditto)
2450 se_mailfrom mailfrom for verify; NULL => ""
2451 pm_mailfrom sender for pm callout check (passed to verify_address())
2452 options callout options (passed to verify_address())
2453 verrno where to put the address basic_errno
2455 If log_msgptr is set to something without setting user_msgptr, the caller
2456 normally uses log_msgptr for both things.
2458 Returns: result of the verification attempt: OK, FAIL, or DEFER;
2459 FAIL is given if no appropriate headers are found
2463 verify_check_header_address(uschar
**user_msgptr
, uschar
**log_msgptr
,
2464 int callout
, int callout_overall
, int callout_connect
, uschar
*se_mailfrom
,
2465 uschar
*pm_mailfrom
, int options
, int *verrno
)
2467 static int header_types
[] = { htype_sender
, htype_reply_to
, htype_from
};
2472 for (i
= 0; i
< 3 && !done
; i
++)
2475 for (h
= header_list
; h
!= NULL
&& !done
; h
= h
->next
)
2477 int terminator
, new_ok
;
2478 uschar
*s
, *ss
, *endname
;
2480 if (h
->type
!= header_types
[i
]) continue;
2481 s
= endname
= Ustrchr(h
->text
, ':') + 1;
2483 /* Scan the addresses in the header, enabling group syntax. Note that we
2484 have to reset this after the header has been scanned. */
2486 parse_allow_group
= TRUE
;
2490 address_item
*vaddr
;
2492 while (isspace(*s
) || *s
== ',') s
++;
2493 if (*s
== 0) break; /* End of header */
2495 ss
= parse_find_address_end(s
, FALSE
);
2497 /* The terminator is a comma or end of header, but there may be white
2498 space preceding it (including newline for the last address). Move back
2499 past any white space so we can check against any cached envelope sender
2500 address verifications. */
2502 while (isspace(ss
[-1])) ss
--;
2506 HDEBUG(D_verify
) debug_printf("verifying %.*s header address %s\n",
2507 (int)(endname
- h
->text
), h
->text
, s
);
2509 /* See if we have already verified this address as an envelope sender,
2510 and if so, use the previous answer. */
2512 vaddr
= verify_checked_sender(s
);
2514 if (vaddr
!= NULL
&& /* Previously checked */
2515 (callout
<= 0 || /* No callout needed; OR */
2516 vaddr
->special_action
> 256)) /* Callout was done */
2518 new_ok
= vaddr
->special_action
& 255;
2519 HDEBUG(D_verify
) debug_printf("previously checked as envelope sender\n");
2520 *ss
= terminator
; /* Restore shortened string */
2523 /* Otherwise we run the verification now. We must restore the shortened
2524 string before running the verification, so the headers are correct, in
2525 case there is any rewriting. */
2529 int start
, end
, domain
;
2530 uschar
*address
= parse_extract_address(s
, log_msgptr
, &start
, &end
,
2535 /* If we found an empty address, just carry on with the next one, but
2536 kill the message. */
2538 if (address
== NULL
&& Ustrcmp(*log_msgptr
, "empty address") == 0)
2545 /* If verification failed because of a syntax error, fail this
2546 function, and ensure that the failing address gets added to the error
2549 if (address
== NULL
)
2552 while (ss
> s
&& isspace(ss
[-1])) ss
--;
2553 *log_msgptr
= string_sprintf("syntax error in '%.*s' header when "
2554 "scanning for sender: %s in \"%.*s\"",
2555 endname
- h
->text
, h
->text
, *log_msgptr
, ss
- s
, s
);
2561 /* Else go ahead with the sender verification. But it isn't *the*
2562 sender of the message, so set vopt_fake_sender to stop sender_address
2563 being replaced after rewriting or qualification. */
2567 vaddr
= deliver_make_addr(address
, FALSE
);
2568 new_ok
= verify_address(vaddr
, NULL
, options
| vopt_fake_sender
,
2569 callout
, callout_overall
, callout_connect
, se_mailfrom
,
2574 /* We now have the result, either newly found, or cached. If we are
2575 giving out error details, set a specific user error. This means that the
2576 last of these will be returned to the user if all three fail. We do not
2577 set a log message - the generic one below will be used. */
2581 *verrno
= vaddr
->basic_errno
;
2582 if (smtp_return_error_details
)
2584 *user_msgptr
= string_sprintf("Rejected after DATA: "
2585 "could not verify \"%.*s\" header address\n%s: %s",
2586 endname
- h
->text
, h
->text
, vaddr
->address
, vaddr
->message
);
2590 /* Success or defer */
2599 if (new_ok
== DEFER
) yield
= DEFER
;
2601 /* Move on to any more addresses in the header */
2604 } /* Next address */
2606 parse_allow_group
= FALSE
;
2607 parse_found_group
= FALSE
;
2608 } /* Next header, unless done */
2609 } /* Next header type unless done */
2611 if (yield
== FAIL
&& *log_msgptr
== NULL
)
2612 *log_msgptr
= US
"there is no valid sender in any header line";
2614 if (yield
== DEFER
&& *log_msgptr
== NULL
)
2615 *log_msgptr
= US
"all attempts to verify a sender in a header line deferred";
2623 /*************************************************
2624 * Get RFC 1413 identification *
2625 *************************************************/
2627 /* Attempt to get an id from the sending machine via the RFC 1413 protocol. If
2628 the timeout is set to zero, then the query is not done. There may also be lists
2629 of hosts and nets which are exempt. To guard against malefactors sending
2630 non-printing characters which could, for example, disrupt a message's headers,
2631 make sure the string consists of printing characters only.
2634 port the port to connect to; usually this is IDENT_PORT (113), but when
2635 running in the test harness with -bh a different value is used.
2639 Side effect: any received ident value is put in sender_ident (NULL otherwise)
2643 verify_get_ident(int port
)
2645 int sock
, host_af
, qlen
;
2646 int received_sender_port
, received_interface_port
, n
;
2648 uschar buffer
[2048];
2650 /* Default is no ident. Check whether we want to do an ident check for this
2653 sender_ident
= NULL
;
2654 if (rfc1413_query_timeout
<= 0 || verify_check_host(&rfc1413_hosts
) != OK
)
2657 DEBUG(D_ident
) debug_printf("doing ident callback\n");
2659 /* Set up a connection to the ident port of the remote host. Bind the local end
2660 to the incoming interface address. If the sender host address is an IPv6
2661 address, the incoming interface address will also be IPv6. */
2663 host_af
= Ustrchr(sender_host_address
, ':') == NULL
? AF_INET
: AF_INET6
;
2664 if ((sock
= ip_socket(SOCK_STREAM
, host_af
)) < 0) return;
2666 if (ip_bind(sock
, host_af
, interface_address
, 0) < 0)
2668 DEBUG(D_ident
) debug_printf("bind socket for ident failed: %s\n",
2673 if (ip_connect(sock
, host_af
, sender_host_address
, port
,
2674 rfc1413_query_timeout
, TRUE
) < 0)
2676 if (errno
== ETIMEDOUT
&& LOGGING(ident_timeout
))
2677 log_write(0, LOG_MAIN
, "ident connection to %s timed out",
2678 sender_host_address
);
2680 DEBUG(D_ident
) debug_printf("ident connection to %s failed: %s\n",
2681 sender_host_address
, strerror(errno
));
2685 /* Construct and send the query. */
2687 sprintf(CS buffer
, "%d , %d\r\n", sender_host_port
, interface_port
);
2688 qlen
= Ustrlen(buffer
);
2689 if (send(sock
, buffer
, qlen
, 0) < 0)
2691 DEBUG(D_ident
) debug_printf("ident send failed: %s\n", strerror(errno
));
2695 /* Read a response line. We put it into the rest of the buffer, using several
2696 recv() calls if necessary. */
2704 int size
= sizeof(buffer
) - (p
- buffer
);
2706 if (size
<= 0) goto END_OFF
; /* Buffer filled without seeing \n. */
2707 count
= ip_recv(sock
, p
, size
, rfc1413_query_timeout
);
2708 if (count
<= 0) goto END_OFF
; /* Read error or EOF */
2710 /* Scan what we just read, to see if we have reached the terminating \r\n. Be
2711 generous, and accept a plain \n terminator as well. The only illegal
2714 for (pp
= p
; pp
< p
+ count
; pp
++)
2716 if (*pp
== 0) goto END_OFF
; /* Zero octet not allowed */
2719 if (pp
[-1] == '\r') pp
--;
2721 goto GOT_DATA
; /* Break out of both loops */
2725 /* Reached the end of the data without finding \n. Let the loop continue to
2726 read some more, if there is room. */
2733 /* We have received a line of data. Check it carefully. It must start with the
2734 same two port numbers that we sent, followed by data as defined by the RFC. For
2737 12345 , 25 : USERID : UNIX :root
2739 However, the amount of white space may be different to what we sent. In the
2740 "osname" field there may be several sub-fields, comma separated. The data we
2741 actually want to save follows the third colon. Some systems put leading spaces
2742 in it - we discard those. */
2744 if (sscanf(CS buffer
+ qlen
, "%d , %d%n", &received_sender_port
,
2745 &received_interface_port
, &n
) != 2 ||
2746 received_sender_port
!= sender_host_port
||
2747 received_interface_port
!= interface_port
)
2750 p
= buffer
+ qlen
+ n
;
2751 while(isspace(*p
)) p
++;
2752 if (*p
++ != ':') goto END_OFF
;
2753 while(isspace(*p
)) p
++;
2754 if (Ustrncmp(p
, "USERID", 6) != 0) goto END_OFF
;
2756 while(isspace(*p
)) p
++;
2757 if (*p
++ != ':') goto END_OFF
;
2758 while (*p
!= 0 && *p
!= ':') p
++;
2759 if (*p
++ == 0) goto END_OFF
;
2760 while(isspace(*p
)) p
++;
2761 if (*p
== 0) goto END_OFF
;
2763 /* The rest of the line is the data we want. We turn it into printing
2764 characters when we save it, so that it cannot mess up the format of any logging
2765 or Received: lines into which it gets inserted. We keep a maximum of 127
2766 characters. The deconst cast is ok as we fed a nonconst to string_printing() */
2768 sender_ident
= US
string_printing(string_copyn(p
, 127));
2769 DEBUG(D_ident
) debug_printf("sender_ident = %s\n", sender_ident
);
2779 /*************************************************
2780 * Match host to a single host-list item *
2781 *************************************************/
2783 /* This function compares a host (name or address) against a single item
2784 from a host list. The host name gets looked up if it is needed and is not
2785 already known. The function is called from verify_check_this_host() via
2786 match_check_list(), which is why most of its arguments are in a single block.
2789 arg the argument block (see below)
2790 ss the host-list item
2791 valueptr where to pass back looked up data, or NULL
2792 error for error message when returning ERROR
2795 host_name (a) the host name, or
2796 (b) NULL, implying use sender_host_name and
2797 sender_host_aliases, looking them up if required, or
2798 (c) the empty string, meaning that only IP address matches
2800 host_address the host address
2801 host_ipv4 the IPv4 address taken from an IPv6 one
2805 DEFER lookup deferred
2806 ERROR (a) failed to find the host name or IP address, or
2807 (b) unknown lookup type specified, or
2808 (c) host name encountered when only IP addresses are
2813 check_host(void *arg
, const uschar
*ss
, const uschar
**valueptr
, uschar
**error
)
2815 check_host_block
*cb
= (check_host_block
*)arg
;
2818 BOOL iplookup
= FALSE
;
2819 BOOL isquery
= FALSE
;
2820 BOOL isiponly
= cb
->host_name
!= NULL
&& cb
->host_name
[0] == 0;
2825 /* Optimize for the special case when the pattern is "*". */
2827 if (*ss
== '*' && ss
[1] == 0) return OK
;
2829 /* If the pattern is empty, it matches only in the case when there is no host -
2830 this can occur in ACL checking for SMTP input using the -bs option. In this
2831 situation, the host address is the empty string. */
2833 if (cb
->host_address
[0] == 0) return (*ss
== 0)? OK
: FAIL
;
2834 if (*ss
== 0) return FAIL
;
2836 /* If the pattern is precisely "@" then match against the primary host name,
2837 provided that host name matching is permitted; if it's "@[]" match against the
2838 local host's IP addresses. */
2844 if (isiponly
) return ERROR
;
2845 ss
= primary_hostname
;
2847 else if (Ustrcmp(ss
, "@[]") == 0)
2849 ip_address_item
*ip
;
2850 for (ip
= host_find_interfaces(); ip
!= NULL
; ip
= ip
->next
)
2851 if (Ustrcmp(ip
->address
, cb
->host_address
) == 0) return OK
;
2856 /* If the pattern is an IP address, optionally followed by a bitmask count, do
2857 a (possibly masked) comparison with the current IP address. */
2859 if (string_is_ip_address(ss
, &maskoffset
) != 0)
2860 return (host_is_in_net(cb
->host_address
, ss
, maskoffset
)? OK
: FAIL
);
2862 /* The pattern is not an IP address. A common error that people make is to omit
2863 one component of an IPv4 address, either by accident, or believing that, for
2864 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,
2865 which it isn't. (Those applications that do accept 1.2.3 as an IP address
2866 interpret it as 1.2.0.3 because the final component becomes 16-bit - this is an
2867 ancient specification.) To aid in debugging these cases, we give a specific
2868 error if the pattern contains only digits and dots or contains a slash preceded
2869 only by digits and dots (a slash at the start indicates a file name and of
2870 course slashes may be present in lookups, but not preceded only by digits and
2873 for (t
= ss
; isdigit(*t
) || *t
== '.'; t
++);
2874 if (*t
== 0 || (*t
== '/' && t
!= ss
))
2876 *error
= US
"malformed IPv4 address or address mask";
2880 /* See if there is a semicolon in the pattern */
2882 semicolon
= Ustrchr(ss
, ';');
2884 /* If we are doing an IP address only match, then all lookups must be IP
2885 address lookups, even if there is no "net-". */
2889 iplookup
= semicolon
!= NULL
;
2892 /* Otherwise, if the item is of the form net[n]-lookup;<file|query> then it is
2893 a lookup on a masked IP network, in textual form. We obey this code even if we
2894 have already set iplookup, so as to skip over the "net-" prefix and to set the
2895 mask length. The net- stuff really only applies to single-key lookups where the
2896 key is implicit. For query-style lookups the key is specified in the query.
2897 From release 4.30, the use of net- for query style is no longer needed, but we
2898 retain it for backward compatibility. */
2900 if (Ustrncmp(ss
, "net", 3) == 0 && semicolon
!= NULL
)
2903 for (t
= ss
+ 3; isdigit(*t
); t
++) mlen
= mlen
* 10 + *t
- '0';
2904 if (mlen
== 0 && t
== ss
+3) mlen
= -1; /* No mask supplied */
2905 iplookup
= (*t
++ == '-');
2909 /* Do the IP address lookup if that is indeed what we have */
2917 uschar
*filename
, *key
, *result
;
2920 /* Find the search type */
2922 search_type
= search_findtype(t
, semicolon
- t
);
2924 if (search_type
< 0) log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "%s",
2925 search_error_message
);
2927 /* Adjust parameters for the type of lookup. For a query-style lookup, there
2928 is no file name, and the "key" is just the query. For query-style with a file
2929 name, we have to fish the file off the start of the query. For a single-key
2930 lookup, the key is the current IP address, masked appropriately, and
2931 reconverted to text form, with the mask appended. For IPv6 addresses, specify
2932 dot separators instead of colons, except when the lookup type is "iplsearch".
2935 if (mac_islookup(search_type
, lookup_absfilequery
))
2937 filename
= semicolon
+ 1;
2939 while (*key
!= 0 && !isspace(*key
)) key
++;
2940 filename
= string_copyn(filename
, key
- filename
);
2941 while (isspace(*key
)) key
++;
2943 else if (mac_islookup(search_type
, lookup_querystyle
))
2946 key
= semicolon
+ 1;
2948 else /* Single-key style */
2950 int sep
= (Ustrcmp(lookup_list
[search_type
]->name
, "iplsearch") == 0)?
2952 insize
= host_aton(cb
->host_address
, incoming
);
2953 host_mask(insize
, incoming
, mlen
);
2954 (void)host_nmtoa(insize
, incoming
, mlen
, buffer
, sep
);
2956 filename
= semicolon
+ 1;
2959 /* Now do the actual lookup; note that there is no search_close() because
2960 of the caching arrangements. */
2962 if (!(handle
= search_open(filename
, search_type
, 0, NULL
, NULL
)))
2963 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "%s", search_error_message
);
2965 result
= search_find(handle
, filename
, key
, -1, NULL
, 0, 0, NULL
);
2966 if (valueptr
!= NULL
) *valueptr
= result
;
2967 return (result
!= NULL
)? OK
: search_find_defer
? DEFER
: FAIL
;
2970 /* The pattern is not an IP address or network reference of any kind. That is,
2971 it is a host name pattern. If this is an IP only match, there's an error in the
2976 *error
= US
"cannot match host name in match_ip list";
2980 /* Check the characters of the pattern to see if they comprise only letters,
2981 digits, full stops, and hyphens (the constituents of domain names). Allow
2982 underscores, as they are all too commonly found. Sigh. Also, if
2983 allow_utf8_domains is set, allow top-bit characters. */
2985 for (t
= ss
; *t
!= 0; t
++)
2986 if (!isalnum(*t
) && *t
!= '.' && *t
!= '-' && *t
!= '_' &&
2987 (!allow_utf8_domains
|| *t
< 128)) break;
2989 /* If the pattern is a complete domain name, with no fancy characters, look up
2990 its IP address and match against that. Note that a multi-homed host will add
2991 items to the chain. */
3002 /* Using byname rather than bydns here means we cannot determine dnssec
3003 status. On the other hand it is unclear how that could be either
3004 propagated up or enforced. */
3006 rc
= host_find_byname(&h
, NULL
, HOST_FIND_QUALIFY_SINGLE
, NULL
, FALSE
);
3007 if (rc
== HOST_FOUND
|| rc
== HOST_FOUND_LOCAL
)
3010 for (hh
= &h
; hh
!= NULL
; hh
= hh
->next
)
3012 if (host_is_in_net(hh
->address
, cb
->host_address
, 0)) return OK
;
3016 if (rc
== HOST_FIND_AGAIN
) return DEFER
;
3017 *error
= string_sprintf("failed to find IP address for %s", ss
);
3021 /* Almost all subsequent comparisons require the host name, and can be done
3022 using the general string matching function. When this function is called for
3023 outgoing hosts, the name is always given explicitly. If it is NULL, it means we
3024 must use sender_host_name and its aliases, looking them up if necessary. */
3026 if (cb
->host_name
!= NULL
) /* Explicit host name given */
3027 return match_check_string(cb
->host_name
, ss
, -1, TRUE
, TRUE
, TRUE
,
3030 /* Host name not given; in principle we need the sender host name and its
3031 aliases. However, for query-style lookups, we do not need the name if the
3032 query does not contain $sender_host_name. From release 4.23, a reference to
3033 $sender_host_name causes it to be looked up, so we don't need to do the lookup
3036 if ((semicolon
= Ustrchr(ss
, ';')) != NULL
)
3038 const uschar
*affix
;
3039 int partial
, affixlen
, starflags
, id
;
3042 id
= search_findtype_partial(ss
, &partial
, &affix
, &affixlen
, &starflags
);
3045 if (id
< 0) /* Unknown lookup type */
3047 log_write(0, LOG_MAIN
|LOG_PANIC
, "%s in host list item \"%s\"",
3048 search_error_message
, ss
);
3051 isquery
= mac_islookup(id
, lookup_querystyle
|lookup_absfilequery
);
3056 switch(match_check_string(US
"", ss
, -1, TRUE
, TRUE
, TRUE
, valueptr
))
3059 case DEFER
: return DEFER
;
3060 default: return FAIL
;
3064 /* Not a query-style lookup; must ensure the host name is present, and then we
3065 do a check on the name and all its aliases. */
3067 if (sender_host_name
== NULL
)
3069 HDEBUG(D_host_lookup
)
3070 debug_printf("sender host name required, to match against %s\n", ss
);
3071 if (host_lookup_failed
|| host_name_lookup() != OK
)
3073 *error
= string_sprintf("failed to find host name for %s",
3074 sender_host_address
);;
3077 host_build_sender_fullhost();
3080 /* Match on the sender host name, using the general matching function */
3082 switch(match_check_string(sender_host_name
, ss
, -1, TRUE
, TRUE
, TRUE
,
3086 case DEFER
: return DEFER
;
3089 /* If there are aliases, try matching on them. */
3091 aliases
= sender_host_aliases
;
3092 while (*aliases
!= NULL
)
3094 switch(match_check_string(*aliases
++, ss
, -1, TRUE
, TRUE
, TRUE
, valueptr
))
3097 case DEFER
: return DEFER
;
3106 /*************************************************
3107 * Check a specific host matches a host list *
3108 *************************************************/
3110 /* This function is passed a host list containing items in a number of
3111 different formats and the identity of a host. Its job is to determine whether
3112 the given host is in the set of hosts defined by the list. The host name is
3113 passed as a pointer so that it can be looked up if needed and not already
3114 known. This is commonly the case when called from verify_check_host() to check
3115 an incoming connection. When called from elsewhere the host name should usually
3118 This function is now just a front end to match_check_list(), which runs common
3119 code for scanning a list. We pass it the check_host() function to perform a
3123 listptr pointer to the host list
3124 cache_bits pointer to cache for named lists, or NULL
3125 host_name the host name or NULL, implying use sender_host_name and
3126 sender_host_aliases, looking them up if required
3127 host_address the IP address
3128 valueptr if not NULL, data from a lookup is passed back here
3130 Returns: OK if the host is in the defined set
3131 FAIL if the host is not in the defined set,
3132 DEFER if a data lookup deferred (not a host lookup)
3134 If the host name was needed in order to make a comparison, and could not be
3135 determined from the IP address, the result is FAIL unless the item
3136 "+allow_unknown" was met earlier in the list, in which case OK is returned. */
3139 verify_check_this_host(const uschar
**listptr
, unsigned int *cache_bits
,
3140 const uschar
*host_name
, const uschar
*host_address
, const uschar
**valueptr
)
3143 unsigned int *local_cache_bits
= cache_bits
;
3144 const uschar
*save_host_address
= deliver_host_address
;
3145 check_host_block cb
;
3146 cb
.host_name
= host_name
;
3147 cb
.host_address
= host_address
;
3149 if (valueptr
!= NULL
) *valueptr
= NULL
;
3151 /* If the host address starts off ::ffff: it is an IPv6 address in
3152 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3155 cb
.host_ipv4
= (Ustrncmp(host_address
, "::ffff:", 7) == 0)?
3156 host_address
+ 7 : host_address
;
3158 /* During the running of the check, put the IP address into $host_address. In
3159 the case of calls from the smtp transport, it will already be there. However,
3160 in other calls (e.g. when testing ignore_target_hosts), it won't. Just to be on
3161 the safe side, any existing setting is preserved, though as I write this
3162 (November 2004) I can't see any cases where it is actually needed. */
3164 deliver_host_address
= host_address
;
3165 rc
= match_check_list(
3166 listptr
, /* the list */
3167 0, /* separator character */
3168 &hostlist_anchor
, /* anchor pointer */
3169 &local_cache_bits
, /* cache pointer */
3170 check_host
, /* function for testing */
3171 &cb
, /* argument for function */
3172 MCL_HOST
, /* type of check */
3173 (host_address
== sender_host_address
)?
3174 US
"host" : host_address
, /* text for debugging */
3175 valueptr
); /* where to pass back data */
3176 deliver_host_address
= save_host_address
;
3183 /*************************************************
3184 * Check the given host item matches a list *
3185 *************************************************/
3187 verify_check_given_host(uschar
**listptr
, host_item
*host
)
3189 return verify_check_this_host(CUSS listptr
, NULL
, host
->name
, host
->address
, NULL
);
3192 /*************************************************
3193 * Check the remote host matches a list *
3194 *************************************************/
3196 /* This is a front end to verify_check_this_host(), created because checking
3197 the remote host is a common occurrence. With luck, a good compiler will spot
3198 the tail recursion and optimize it. If there's no host address, this is
3199 command-line SMTP input - check against an empty string for the address.
3202 listptr pointer to the host list
3204 Returns: the yield of verify_check_this_host(),
3205 i.e. OK, FAIL, or DEFER
3209 verify_check_host(uschar
**listptr
)
3211 return verify_check_this_host(CUSS listptr
, sender_host_cache
, NULL
,
3212 (sender_host_address
== NULL
)? US
"" : sender_host_address
, NULL
);
3219 /*************************************************
3220 * Invert an IP address *
3221 *************************************************/
3223 /* Originally just used for DNS xBL lists, now also used for the
3224 reverse_ip expansion operator.
3227 buffer where to put the answer
3228 address the address to invert
3232 invert_address(uschar
*buffer
, uschar
*address
)
3235 uschar
*bptr
= buffer
;
3237 /* If this is an IPv4 address mapped into IPv6 format, adjust the pointer
3238 to the IPv4 part only. */
3240 if (Ustrncmp(address
, "::ffff:", 7) == 0) address
+= 7;
3242 /* Handle IPv4 address: when HAVE_IPV6 is false, the result of host_aton() is
3245 if (host_aton(address
, bin
) == 1)
3249 for (i
= 0; i
< 4; i
++)
3251 sprintf(CS bptr
, "%d.", x
& 255);
3252 while (*bptr
) bptr
++;
3257 /* Handle IPv6 address. Actually, as far as I know, there are no IPv6 addresses
3258 in any DNS black lists, and the format in which they will be looked up is
3259 unknown. This is just a guess. */
3265 for (j
= 3; j
>= 0; j
--)
3268 for (i
= 0; i
< 8; i
++)
3270 sprintf(CS bptr
, "%x.", x
& 15);
3271 while (*bptr
) bptr
++;
3278 /* Remove trailing period -- this is needed so that both arbitrary
3279 dnsbl keydomains and inverted addresses may be combined with the
3280 same format string, "%s.%s" */
3287 /*************************************************
3288 * Perform a single dnsbl lookup *
3289 *************************************************/
3291 /* This function is called from verify_check_dnsbl() below. It is also called
3292 recursively from within itself when domain and domain_txt are different
3293 pointers, in order to get the TXT record from the alternate domain.
3296 domain the outer dnsbl domain
3297 domain_txt alternate domain to lookup TXT record on success; when the
3298 same domain is to be used, domain_txt == domain (that is,
3299 the pointers must be identical, not just the text)
3300 keydomain the current keydomain (for debug message)
3301 prepend subdomain to lookup (like keydomain, but
3302 reversed if IP address)
3303 iplist the list of matching IP addresses, or NULL for "any"
3304 bitmask true if bitmask matching is wanted
3305 match_type condition for 'succeed' result
3306 0 => Any RR in iplist (=)
3307 1 => No RR in iplist (!=)
3308 2 => All RRs in iplist (==)
3309 3 => Some RRs not in iplist (!==)
3310 the two bits are defined as MT_NOT and MT_ALL
3311 defer_return what to return for a defer
3313 Returns: OK if lookup succeeded
3318 one_check_dnsbl(uschar
*domain
, uschar
*domain_txt
, uschar
*keydomain
,
3319 uschar
*prepend
, uschar
*iplist
, BOOL bitmask
, int match_type
,
3325 dnsbl_cache_block
*cb
;
3326 int old_pool
= store_pool
;
3327 uschar query
[256]; /* DNS domain max length */
3329 /* Construct the specific query domainname */
3331 if (!string_format(query
, sizeof(query
), "%s.%s", prepend
, domain
))
3333 log_write(0, LOG_MAIN
|LOG_PANIC
, "dnslist query is too long "
3334 "(ignored): %s...", query
);
3338 /* Look for this query in the cache. */
3340 if ( (t
= tree_search(dnsbl_cache
, query
))
3341 && (cb
= t
->data
.ptr
)->expiry
> time(NULL
)
3344 /* Previous lookup was cached */
3347 HDEBUG(D_dnsbl
) debug_printf("using result of previous DNS lookup\n");
3350 /* If not cached from a previous lookup, we must do a DNS lookup, and
3351 cache the result in permanent memory. */
3357 store_pool
= POOL_PERM
;
3361 HDEBUG(D_dnsbl
) debug_printf("cached data found but past valid time; ");
3365 { /* Set up a tree entry to cache the lookup */
3366 t
= store_get(sizeof(tree_node
) + Ustrlen(query
));
3367 Ustrcpy(t
->name
, query
);
3368 t
->data
.ptr
= cb
= store_get(sizeof(dnsbl_cache_block
));
3369 (void)tree_insertnode(&dnsbl_cache
, t
);
3372 /* Do the DNS lookup . */
3374 HDEBUG(D_dnsbl
) debug_printf("new DNS lookup for %s\n", query
);
3375 cb
->rc
= dns_basic_lookup(&dnsa
, query
, T_A
);
3376 cb
->text_set
= FALSE
;
3380 /* If the lookup succeeded, cache the RHS address. The code allows for
3381 more than one address - this was for complete generality and the possible
3382 use of A6 records. However, A6 records have been reduced to experimental
3383 status (August 2001) and may die out. So they may never get used at all,
3384 let alone in dnsbl records. However, leave the code here, just in case.
3386 Quite apart from one A6 RR generating multiple addresses, there are DNS
3387 lists that return more than one A record, so we must handle multiple
3388 addresses generated in that way as well.
3390 Mark the cache entry with the "now" plus the minimum of the address TTLs,
3391 or some suitably far-future time if none were found. */
3393 if (cb
->rc
== DNS_SUCCEED
)
3396 dns_address
**addrp
= &(cb
->rhs
);
3397 for (rr
= dns_next_rr(&dnsa
, &dnss
, RESET_ANSWERS
);
3399 rr
= dns_next_rr(&dnsa
, &dnss
, RESET_NEXT
))
3401 if (rr
->type
== T_A
)
3403 dns_address
*da
= dns_address_from_rr(&dnsa
, rr
);
3407 while (da
->next
!= NULL
) da
= da
->next
;
3408 addrp
= &(da
->next
);
3409 if (ttl
> rr
->ttl
) ttl
= rr
->ttl
;
3414 /* If we didn't find any A records, change the return code. This can
3415 happen when there is a CNAME record but there are no A records for what
3418 if (cb
->rhs
== NULL
) cb
->rc
= DNS_NODATA
;
3421 cb
->expiry
= time(NULL
)+ttl
;
3422 store_pool
= old_pool
;
3425 /* We now have the result of the DNS lookup, either newly done, or cached
3426 from a previous call. If the lookup succeeded, check against the address
3427 list if there is one. This may be a positive equality list (introduced by
3428 "="), a negative equality list (introduced by "!="), a positive bitmask
3429 list (introduced by "&"), or a negative bitmask list (introduced by "!&").*/
3431 if (cb
->rc
== DNS_SUCCEED
)
3433 dns_address
*da
= NULL
;
3434 uschar
*addlist
= cb
->rhs
->address
;
3436 /* For A and AAAA records, there may be multiple addresses from multiple
3437 records. For A6 records (currently not expected to be used) there may be
3438 multiple addresses from a single record. */
3440 for (da
= cb
->rhs
->next
; da
!= NULL
; da
= da
->next
)
3441 addlist
= string_sprintf("%s, %s", addlist
, da
->address
);
3443 HDEBUG(D_dnsbl
) debug_printf("DNS lookup for %s succeeded (yielding %s)\n",
3446 /* Address list check; this can be either for equality, or via a bitmask.
3447 In the latter case, all the bits must match. */
3451 for (da
= cb
->rhs
; da
!= NULL
; da
= da
->next
)
3455 const uschar
*ptr
= iplist
;
3458 /* Handle exact matching */
3462 while ((res
= string_nextinlist(&ptr
, &ipsep
, ip
, sizeof(ip
))) != NULL
)
3464 if (Ustrcmp(CS da
->address
, ip
) == 0) break;
3468 /* Handle bitmask matching */
3475 /* At present, all known DNS blocking lists use A records, with
3476 IPv4 addresses on the RHS encoding the information they return. I
3477 wonder if this will linger on as the last vestige of IPv4 when IPv6
3478 is ubiquitous? Anyway, for now we use paranoia code to completely
3479 ignore IPv6 addresses. The default mask is 0, which always matches.
3480 We change this only for IPv4 addresses in the list. */
3482 if (host_aton(da
->address
, address
) == 1) mask
= address
[0];
3484 /* Scan the returned addresses, skipping any that are IPv6 */
3486 while ((res
= string_nextinlist(&ptr
, &ipsep
, ip
, sizeof(ip
))) != NULL
)
3488 if (host_aton(ip
, address
) != 1) continue;
3489 if ((address
[0] & mask
) == address
[0]) break;
3495 (a) An IP address in an any ('=') list matched, or
3496 (b) No IP address in an all ('==') list matched
3498 then we're done searching. */
3500 if (((match_type
& MT_ALL
) != 0) == (res
== NULL
)) break;
3503 /* If da == NULL, either
3505 (a) No IP address in an any ('=') list matched, or
3506 (b) An IP address in an all ('==') list didn't match
3508 so behave as if the DNSBL lookup had not succeeded, i.e. the host is not on
3511 if ((match_type
== MT_NOT
|| match_type
== MT_ALL
) != (da
== NULL
))
3519 res
= US
"was no match";
3522 res
= US
"was an exclude match";
3525 res
= US
"was an IP address that did not match";
3528 res
= US
"were no IP addresses that did not match";
3531 debug_printf("=> but we are not accepting this block class because\n");
3532 debug_printf("=> there %s for %s%c%s\n",
3534 ((match_type
& MT_ALL
) == 0)? "" : "=",
3535 bitmask
? '&' : '=', iplist
);
3541 /* Either there was no IP list, or the record matched, implying that the
3542 domain is on the list. We now want to find a corresponding TXT record. If an
3543 alternate domain is specified for the TXT record, call this function
3544 recursively to look that up; this has the side effect of re-checking that
3545 there is indeed an A record at the alternate domain. */
3547 if (domain_txt
!= domain
)
3548 return one_check_dnsbl(domain_txt
, domain_txt
, keydomain
, prepend
, NULL
,
3549 FALSE
, match_type
, defer_return
);
3551 /* If there is no alternate domain, look up a TXT record in the main domain
3552 if it has not previously been cached. */
3556 cb
->text_set
= TRUE
;
3557 if (dns_basic_lookup(&dnsa
, query
, T_TXT
) == DNS_SUCCEED
)
3560 for (rr
= dns_next_rr(&dnsa
, &dnss
, RESET_ANSWERS
);
3562 rr
= dns_next_rr(&dnsa
, &dnss
, RESET_NEXT
))
3563 if (rr
->type
== T_TXT
) break;
3566 int len
= (rr
->data
)[0];
3567 if (len
> 511) len
= 127;
3568 store_pool
= POOL_PERM
;
3569 cb
->text
= string_sprintf("%.*s", len
, (const uschar
*)(rr
->data
+1));
3570 store_pool
= old_pool
;
3575 dnslist_value
= addlist
;
3576 dnslist_text
= cb
->text
;
3580 /* There was a problem with the DNS lookup */
3582 if (cb
->rc
!= DNS_NOMATCH
&& cb
->rc
!= DNS_NODATA
)
3584 log_write(L_dnslist_defer
, LOG_MAIN
,
3585 "DNS list lookup defer (probably timeout) for %s: %s", query
,
3586 (defer_return
== OK
)? US
"assumed in list" :
3587 (defer_return
== FAIL
)? US
"assumed not in list" :
3588 US
"returned DEFER");
3589 return defer_return
;
3592 /* No entry was found in the DNS; continue for next domain */
3596 debug_printf("DNS lookup for %s failed\n", query
);
3597 debug_printf("=> that means %s is not listed at %s\n",
3607 /*************************************************
3608 * Check host against DNS black lists *
3609 *************************************************/
3611 /* This function runs checks against a list of DNS black lists, until one
3612 matches. Each item on the list can be of the form
3614 domain=ip-address/key
3616 The domain is the right-most domain that is used for the query, for example,
3617 blackholes.mail-abuse.org. If the IP address is present, there is a match only
3618 if the DNS lookup returns a matching IP address. Several addresses may be
3619 given, comma-separated, for example: x.y.z=127.0.0.1,127.0.0.2.
3621 If no key is given, what is looked up in the domain is the inverted IP address
3622 of the current client host. If a key is given, it is used to construct the
3623 domain for the lookup. For example:
3625 dsn.rfc-ignorant.org/$sender_address_domain
3627 After finding a match in the DNS, the domain is placed in $dnslist_domain, and
3628 then we check for a TXT record for an error message, and if found, save its
3629 value in $dnslist_text. We also cache everything in a tree, to optimize
3632 The TXT record is normally looked up in the same domain as the A record, but
3633 when many lists are combined in a single DNS domain, this will not be a very
3634 specific message. It is possible to specify a different domain for looking up
3635 TXT records; this is given before the main domain, comma-separated. For
3638 dnslists = http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
3639 socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3
3641 The caching ensures that only one lookup in dnsbl.sorbs.net is done.
3643 Note: an address for testing RBL is 192.203.178.39
3644 Note: an address for testing DUL is 192.203.178.4
3645 Note: a domain for testing RFCI is example.tld.dsn.rfc-ignorant.org
3649 listptr the domain/address/data list
3650 log_msgptr log message on error
3652 Returns: OK successful lookup (i.e. the address is on the list), or
3653 lookup deferred after +include_unknown
3654 FAIL name not found, or no data found for the given type, or
3655 lookup deferred after +exclude_unknown (default)
3656 DEFER lookup failure, if +defer_unknown was set
3660 verify_check_dnsbl(int where
, const uschar
** listptr
, uschar
** log_msgptr
)
3663 int defer_return
= FAIL
;
3664 const uschar
*list
= *listptr
;
3667 uschar buffer
[1024];
3668 uschar revadd
[128]; /* Long enough for IPv6 address */
3670 /* Indicate that the inverted IP address is not yet set up */
3674 /* In case this is the first time the DNS resolver is being used. */
3676 dns_init(FALSE
, FALSE
, FALSE
); /*XXX dnssec? */
3678 /* Loop through all the domains supplied, until something matches */
3680 while ((domain
= string_nextinlist(&list
, &sep
, buffer
, sizeof(buffer
))) != NULL
)
3683 BOOL bitmask
= FALSE
;
3690 HDEBUG(D_dnsbl
) debug_printf("DNS list check: %s\n", domain
);
3692 /* Deal with special values that change the behaviour on defer */
3694 if (domain
[0] == '+')
3696 if (strcmpic(domain
, US
"+include_unknown") == 0) defer_return
= OK
;
3697 else if (strcmpic(domain
, US
"+exclude_unknown") == 0) defer_return
= FAIL
;
3698 else if (strcmpic(domain
, US
"+defer_unknown") == 0) defer_return
= DEFER
;
3700 log_write(0, LOG_MAIN
|LOG_PANIC
, "unknown item in dnslist (ignored): %s",
3705 /* See if there's explicit data to be looked up */
3707 if ((key
= Ustrchr(domain
, '/'))) *key
++ = 0;
3709 /* See if there's a list of addresses supplied after the domain name. This is
3710 introduced by an = or a & character; if preceded by = we require all matches
3711 and if preceded by ! we invert the result. */
3713 if (!(iplist
= Ustrchr(domain
, '=')))
3716 iplist
= Ustrchr(domain
, '&');
3719 if (iplist
) /* Found either = or & */
3721 if (iplist
> domain
&& iplist
[-1] == '!') /* Handle preceding ! */
3723 match_type
|= MT_NOT
;
3727 *iplist
++ = 0; /* Terminate domain, move on */
3729 /* If we found = (bitmask == FALSE), check for == or =& */
3731 if (!bitmask
&& (*iplist
== '=' || *iplist
== '&'))
3733 bitmask
= *iplist
++ == '&';
3734 match_type
|= MT_ALL
;
3739 /* If there is a comma in the domain, it indicates that a second domain for
3740 looking up TXT records is provided, before the main domain. Otherwise we must
3741 set domain_txt == domain. */
3743 domain_txt
= domain
;
3744 comma
= Ustrchr(domain
, ',');
3751 /* Check that what we have left is a sensible domain name. There is no reason
3752 why these domains should in fact use the same syntax as hosts and email
3753 domains, but in practice they seem to. However, there is little point in
3754 actually causing an error here, because that would no doubt hold up incoming
3755 mail. Instead, I'll just log it. */
3757 for (s
= domain
; *s
!= 0; s
++)
3759 if (!isalnum(*s
) && *s
!= '-' && *s
!= '.' && *s
!= '_')
3761 log_write(0, LOG_MAIN
, "dnslists domain \"%s\" contains "
3762 "strange characters - is this right?", domain
);
3767 /* Check the alternate domain if present */
3769 if (domain_txt
!= domain
) for (s
= domain_txt
; *s
!= 0; s
++)
3771 if (!isalnum(*s
) && *s
!= '-' && *s
!= '.' && *s
!= '_')
3773 log_write(0, LOG_MAIN
, "dnslists domain \"%s\" contains "
3774 "strange characters - is this right?", domain_txt
);
3779 /* If there is no key string, construct the query by adding the domain name
3780 onto the inverted host address, and perform a single DNS lookup. */
3784 if (where
== ACL_WHERE_NOTSMTP_START
|| where
== ACL_WHERE_NOTSMTP
)
3786 *log_msgptr
= string_sprintf
3787 ("cannot test auto-keyed dnslists condition in %s ACL",
3788 acl_wherenames
[where
]);
3791 if (sender_host_address
== NULL
) return FAIL
; /* can never match */
3792 if (revadd
[0] == 0) invert_address(revadd
, sender_host_address
);
3793 rc
= one_check_dnsbl(domain
, domain_txt
, sender_host_address
, revadd
,
3794 iplist
, bitmask
, match_type
, defer_return
);
3797 dnslist_domain
= string_copy(domain_txt
);
3798 dnslist_matched
= string_copy(sender_host_address
);
3799 HDEBUG(D_dnsbl
) debug_printf("=> that means %s is listed at %s\n",
3800 sender_host_address
, dnslist_domain
);
3802 if (rc
!= FAIL
) return rc
; /* OK or DEFER */
3805 /* If there is a key string, it can be a list of domains or IP addresses to
3806 be concatenated with the main domain. */
3813 uschar keybuffer
[256];
3814 uschar keyrevadd
[128];
3816 while ((keydomain
= string_nextinlist(CUSS
&key
, &keysep
, keybuffer
,
3817 sizeof(keybuffer
))) != NULL
)
3819 uschar
*prepend
= keydomain
;
3821 if (string_is_ip_address(keydomain
, NULL
) != 0)
3823 invert_address(keyrevadd
, keydomain
);
3824 prepend
= keyrevadd
;
3827 rc
= one_check_dnsbl(domain
, domain_txt
, keydomain
, prepend
, iplist
,
3828 bitmask
, match_type
, defer_return
);
3832 dnslist_domain
= string_copy(domain_txt
);
3833 dnslist_matched
= string_copy(keydomain
);
3834 HDEBUG(D_dnsbl
) debug_printf("=> that means %s is listed at %s\n",
3835 keydomain
, dnslist_domain
);
3839 /* If the lookup deferred, remember this fact. We keep trying the rest
3840 of the list to see if we get a useful result, and if we don't, we return
3841 DEFER at the end. */
3843 if (rc
== DEFER
) defer
= TRUE
;
3844 } /* continue with next keystring domain/address */
3846 if (defer
) return DEFER
;
3848 } /* continue with next dnsdb outer domain */
3855 /* End of verify.c */