1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2014 */
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 address_item cutthrough_addr
;
18 static smtp_outblock ctblock
;
19 uschar ctbuffer
[8192];
22 /* Structure for caching DNSBL lookups */
24 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() */
44 /*************************************************
45 * Retrieve a callout cache record *
46 *************************************************/
48 /* If a record exists, check whether it has expired.
51 dbm_file an open hints file
53 type "address" or "domain"
54 positive_expire expire time for positive records
55 negative_expire expire time for negative records
57 Returns: the cache record if a non-expired one exists, else NULL
60 static dbdata_callout_cache
*
61 get_callout_cache_record(open_db
*dbm_file
, uschar
*key
, uschar
*type
,
62 int positive_expire
, int negative_expire
)
67 dbdata_callout_cache
*cache_record
;
69 cache_record
= dbfn_read_with_length(dbm_file
, key
, &length
);
71 if (cache_record
== NULL
)
73 HDEBUG(D_verify
) debug_printf("callout cache: no %s record found\n", type
);
77 /* We treat a record as "negative" if its result field is not positive, or if
78 it is a domain record and the postmaster field is negative. */
80 negative
= cache_record
->result
!= ccache_accept
||
81 (type
[0] == 'd' && cache_record
->postmaster_result
== ccache_reject
);
82 expire
= negative
? negative_expire
: positive_expire
;
85 if (now
- cache_record
->time_stamp
> expire
)
87 HDEBUG(D_verify
) debug_printf("callout cache: %s record expired\n", type
);
91 /* If this is a non-reject domain record, check for the obsolete format version
92 that doesn't have the postmaster and random timestamps, by looking at the
93 length. If so, copy it to a new-style block, replicating the record's
94 timestamp. Then check the additional timestamps. (There's no point wasting
95 effort if connections are rejected.) */
97 if (type
[0] == 'd' && cache_record
->result
!= ccache_reject
)
99 if (length
== sizeof(dbdata_callout_cache_obs
))
101 dbdata_callout_cache
*new = store_get(sizeof(dbdata_callout_cache
));
102 memcpy(new, cache_record
, length
);
103 new->postmaster_stamp
= new->random_stamp
= new->time_stamp
;
107 if (now
- cache_record
->postmaster_stamp
> expire
)
108 cache_record
->postmaster_result
= ccache_unknown
;
110 if (now
- cache_record
->random_stamp
> expire
)
111 cache_record
->random_result
= ccache_unknown
;
114 HDEBUG(D_verify
) debug_printf("callout cache: found %s record\n", type
);
120 /*************************************************
121 * Do callout verification for an address *
122 *************************************************/
124 /* This function is called from verify_address() when the address has routed to
125 a host list, and a callout has been requested. Callouts are expensive; that is
126 why a cache is used to improve the efficiency.
129 addr the address that's been routed
130 host_list the list of hosts to try
131 tf the transport feedback block
133 ifstring "interface" option from transport, or NULL
134 portstring "port" option from transport, or NULL
135 protocolstring "protocol" option from transport, or NULL
136 callout the per-command callout timeout
137 callout_overall the overall callout timeout (if < 0 use 4*callout)
138 callout_connect the callout connection timeout (if < 0 use callout)
139 options the verification options - these bits are used:
140 vopt_is_recipient => this is a recipient address
141 vopt_callout_no_cache => don't use callout cache
142 vopt_callout_fullpm => if postmaster check, do full one
143 vopt_callout_random => do the "random" thing
144 vopt_callout_recipsender => use real sender for recipient
145 vopt_callout_recippmaster => use postmaster for recipient
146 se_mailfrom MAIL FROM address for sender verify; NULL => ""
147 pm_mailfrom if non-NULL, do the postmaster check with this sender
149 Returns: OK/FAIL/DEFER
153 do_callout(address_item
*addr
, host_item
*host_list
, transport_feedback
*tf
,
154 int callout
, int callout_overall
, int callout_connect
, int options
,
155 uschar
*se_mailfrom
, uschar
*pm_mailfrom
)
157 BOOL is_recipient
= (options
& vopt_is_recipient
) != 0;
158 BOOL callout_no_cache
= (options
& vopt_callout_no_cache
) != 0;
159 BOOL callout_random
= (options
& vopt_callout_random
) != 0;
162 int old_domain_cache_result
= ccache_accept
;
165 uschar
*from_address
;
166 uschar
*random_local_part
= NULL
;
167 uschar
*save_deliver_domain
= deliver_domain
;
168 uschar
**failure_ptr
= is_recipient
?
169 &recipient_verify_failure
: &sender_verify_failure
;
171 open_db
*dbm_file
= NULL
;
172 dbdata_callout_cache new_domain_record
;
173 dbdata_callout_cache_address new_address_record
;
175 time_t callout_start_time
;
177 new_domain_record
.result
= ccache_unknown
;
178 new_domain_record
.postmaster_result
= ccache_unknown
;
179 new_domain_record
.random_result
= ccache_unknown
;
181 memset(&new_address_record
, 0, sizeof(new_address_record
));
183 /* For a recipient callout, the key used for the address cache record must
184 include the sender address if we are using the real sender in the callout,
185 because that may influence the result of the callout. */
187 address_key
= addr
->address
;
192 if ((options
& vopt_callout_recipsender
) != 0)
194 address_key
= string_sprintf("%s/<%s>", addr
->address
, sender_address
);
195 from_address
= sender_address
;
197 else if ((options
& vopt_callout_recippmaster
) != 0)
199 address_key
= string_sprintf("%s/<postmaster@%s>", addr
->address
,
200 qualify_domain_sender
);
201 from_address
= string_sprintf("postmaster@%s", qualify_domain_sender
);
205 /* For a sender callout, we must adjust the key if the mailfrom address is not
210 from_address
= (se_mailfrom
== NULL
)? US
"" : se_mailfrom
;
211 if (from_address
[0] != 0)
212 address_key
= string_sprintf("%s/<%s>", addr
->address
, from_address
);
215 /* Open the callout cache database, it it exists, for reading only at this
216 stage, unless caching has been disabled. */
218 if (callout_no_cache
)
220 HDEBUG(D_verify
) debug_printf("callout cache: disabled by no_cache\n");
222 else if ((dbm_file
= dbfn_open(US
"callout", O_RDWR
, &dbblock
, FALSE
)) == NULL
)
224 HDEBUG(D_verify
) debug_printf("callout cache: not available\n");
227 /* If a cache database is available see if we can avoid the need to do an
228 actual callout by making use of previously-obtained data. */
230 if (dbm_file
!= NULL
)
232 dbdata_callout_cache_address
*cache_address_record
;
233 dbdata_callout_cache
*cache_record
= get_callout_cache_record(dbm_file
,
234 addr
->domain
, US
"domain",
235 callout_cache_domain_positive_expire
,
236 callout_cache_domain_negative_expire
);
238 /* If an unexpired cache record was found for this domain, see if the callout
239 process can be short-circuited. */
241 if (cache_record
!= NULL
)
243 /* In most cases, if an early command (up to and including MAIL FROM:<>)
244 was rejected, there is no point carrying on. The callout fails. However, if
245 we are doing a recipient verification with use_sender or use_postmaster
246 set, a previous failure of MAIL FROM:<> doesn't count, because this time we
247 will be using a non-empty sender. We have to remember this situation so as
248 not to disturb the cached domain value if this whole verification succeeds
249 (we don't want it turning into "accept"). */
251 old_domain_cache_result
= cache_record
->result
;
253 if (cache_record
->result
== ccache_reject
||
254 (*from_address
== 0 && cache_record
->result
== ccache_reject_mfnull
))
256 setflag(addr
, af_verify_nsfail
);
258 debug_printf("callout cache: domain gave initial rejection, or "
259 "does not accept HELO or MAIL FROM:<>\n");
260 setflag(addr
, af_verify_nsfail
);
261 addr
->user_message
= US
"(result of an earlier callout reused).";
263 *failure_ptr
= US
"mail";
267 /* If a previous check on a "random" local part was accepted, we assume
268 that the server does not do any checking on local parts. There is therefore
269 no point in doing the callout, because it will always be successful. If a
270 random check previously failed, arrange not to do it again, but preserve
271 the data in the new record. If a random check is required but hasn't been
272 done, skip the remaining cache processing. */
274 if (callout_random
) switch(cache_record
->random_result
)
278 debug_printf("callout cache: domain accepts random addresses\n");
279 goto END_CALLOUT
; /* Default yield is OK */
283 debug_printf("callout cache: domain rejects random addresses\n");
284 callout_random
= FALSE
;
285 new_domain_record
.random_result
= ccache_reject
;
286 new_domain_record
.random_stamp
= cache_record
->random_stamp
;
291 debug_printf("callout cache: need to check random address handling "
292 "(not cached or cache expired)\n");
296 /* If a postmaster check is requested, but there was a previous failure,
297 there is again no point in carrying on. If a postmaster check is required,
298 but has not been done before, we are going to have to do a callout, so skip
299 remaining cache processing. */
301 if (pm_mailfrom
!= NULL
)
303 if (cache_record
->postmaster_result
== ccache_reject
)
305 setflag(addr
, af_verify_pmfail
);
307 debug_printf("callout cache: domain does not accept "
308 "RCPT TO:<postmaster@domain>\n");
310 *failure_ptr
= US
"postmaster";
311 setflag(addr
, af_verify_pmfail
);
312 addr
->user_message
= US
"(result of earlier verification reused).";
315 if (cache_record
->postmaster_result
== ccache_unknown
)
318 debug_printf("callout cache: need to check RCPT "
319 "TO:<postmaster@domain> (not cached or cache expired)\n");
323 /* If cache says OK, set pm_mailfrom NULL to prevent a redundant
324 postmaster check if the address itself has to be checked. Also ensure
325 that the value in the cache record is preserved (with its old timestamp).
328 HDEBUG(D_verify
) debug_printf("callout cache: domain accepts RCPT "
329 "TO:<postmaster@domain>\n");
331 new_domain_record
.postmaster_result
= ccache_accept
;
332 new_domain_record
.postmaster_stamp
= cache_record
->postmaster_stamp
;
336 /* We can't give a result based on information about the domain. See if there
337 is an unexpired cache record for this specific address (combined with the
338 sender address if we are doing a recipient callout with a non-empty sender).
341 cache_address_record
= (dbdata_callout_cache_address
*)
342 get_callout_cache_record(dbm_file
,
343 address_key
, US
"address",
344 callout_cache_positive_expire
,
345 callout_cache_negative_expire
);
347 if (cache_address_record
!= NULL
)
349 if (cache_address_record
->result
== ccache_accept
)
352 debug_printf("callout cache: address record is positive\n");
357 debug_printf("callout cache: address record is negative\n");
358 addr
->user_message
= US
"Previous (cached) callout verification failure";
359 *failure_ptr
= US
"recipient";
365 /* Close the cache database while we actually do the callout for real. */
368 dbfn_close(dbm_file
);
372 if (!addr
->transport
)
374 HDEBUG(D_verify
) debug_printf("cannot callout via null transport\n");
378 smtp_transport_options_block
*ob
=
379 (smtp_transport_options_block
*)(addr
->transport
->options_block
);
381 /* The information wasn't available in the cache, so we have to do a real
382 callout and save the result in the cache for next time, unless no_cache is set,
383 or unless we have a previously cached negative random result. If we are to test
384 with a random local part, ensure that such a local part is available. If not,
385 log the fact, but carry on without randomming. */
387 if (callout_random
&& callout_random_local_part
!= NULL
)
389 random_local_part
= expand_string(callout_random_local_part
);
390 if (random_local_part
== NULL
)
391 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to expand "
392 "callout_random_local_part: %s", expand_string_message
);
395 /* Default the connect and overall callout timeouts if not set, and record the
396 time we are starting so that we can enforce it. */
398 if (callout_overall
< 0) callout_overall
= 4 * callout
;
399 if (callout_connect
< 0) callout_connect
= callout
;
400 callout_start_time
= time(NULL
);
402 /* Before doing a real callout, if this is an SMTP connection, flush the SMTP
403 output because a callout might take some time. When PIPELINING is active and
404 there are many recipients, the total time for doing lots of callouts can add up
405 and cause the client to time out. So in this case we forgo the PIPELINING
408 if (smtp_out
!= NULL
&& !disable_callout_flush
) mac_smtp_fflush();
410 /* Now make connections to the hosts and do real callouts. The list of hosts
411 is passed in as an argument. */
413 for (host
= host_list
; host
!= NULL
&& !done
; host
= host
->next
)
415 smtp_inblock inblock
;
416 smtp_outblock outblock
;
419 BOOL send_quit
= TRUE
;
420 uschar
*active_hostname
= smtp_active_hostname
;
424 BOOL suppress_tls
= FALSE
;
425 uschar
*interface
= NULL
; /* Outgoing interface to use; NULL => any */
426 uschar inbuffer
[4096];
427 uschar outbuffer
[1024];
428 uschar responsebuffer
[4096];
430 clearflag(addr
, af_verify_pmfail
); /* postmaster callout flag */
431 clearflag(addr
, af_verify_nsfail
); /* null sender callout flag */
433 /* Skip this host if we don't have an IP address for it. */
435 if (host
->address
== NULL
)
437 DEBUG(D_verify
) debug_printf("no IP address for host name %s: skipping\n",
442 /* Check the overall callout timeout */
444 if (time(NULL
) - callout_start_time
>= callout_overall
)
446 HDEBUG(D_verify
) debug_printf("overall timeout for callout exceeded\n");
450 /* Set IPv4 or IPv6 */
452 host_af
= (Ustrchr(host
->address
, ':') == NULL
)? AF_INET
:AF_INET6
;
454 /* Expand and interpret the interface and port strings. The latter will not
455 be used if there is a host-specific port (e.g. from a manualroute router).
456 This has to be delayed till now, because they may expand differently for
457 different hosts. If there's a failure, log it, but carry on with the
460 deliver_host
= host
->name
;
461 deliver_host_address
= host
->address
;
462 deliver_domain
= addr
->domain
;
464 if (!smtp_get_interface(tf
->interface
, host_af
, addr
, NULL
, &interface
,
466 !smtp_get_port(tf
->port
, addr
, &port
, US
"callout"))
467 log_write(0, LOG_MAIN
|LOG_PANIC
, "<%s>: %s", addr
->address
,
470 /* Set HELO string according to the protocol */
471 lmtp
= Ustrcmp(tf
->protocol
, "lmtp") == 0;
472 smtps
= Ustrcmp(tf
->protocol
, "smtps") == 0;
475 HDEBUG(D_verify
) debug_printf("interface=%s port=%d\n", interface
, port
);
477 /* Set up the buffer for reading SMTP response packets. */
479 inblock
.buffer
= inbuffer
;
480 inblock
.buffersize
= sizeof(inbuffer
);
481 inblock
.ptr
= inbuffer
;
482 inblock
.ptrend
= inbuffer
;
484 /* Set up the buffer for holding SMTP commands while pipelining */
486 outblock
.buffer
= outbuffer
;
487 outblock
.buffersize
= sizeof(outbuffer
);
488 outblock
.ptr
= outbuffer
;
489 outblock
.cmd_count
= 0;
490 outblock
.authenticating
= FALSE
;
492 /* Reset the parameters of a TLS session */
493 tls_out
.cipher
= tls_out
.peerdn
= NULL
;
495 /* Connect to the host; on failure, just loop for the next one, but we
496 set the error for the last one. Use the callout_connect timeout. */
498 tls_retry_connection
:
500 inblock
.sock
= outblock
.sock
=
501 smtp_connect(host
, host_af
, port
, interface
, callout_connect
, TRUE
, NULL
);
502 /* reconsider DSCP here */
503 if (inblock
.sock
< 0)
505 addr
->message
= string_sprintf("could not connect to %s [%s]: %s",
506 host
->name
, host
->address
, strerror(errno
));
507 deliver_host
= deliver_host_address
= NULL
;
508 deliver_domain
= save_deliver_domain
;
512 /* Expand the helo_data string to find the host name to use. */
514 if (tf
->helo_data
!= NULL
)
516 uschar
*s
= expand_string(tf
->helo_data
);
518 log_write(0, LOG_MAIN
|LOG_PANIC
, "<%s>: failed to expand transport's "
519 "helo_data value for callout: %s", addr
->address
,
520 expand_string_message
);
521 else active_hostname
= s
;
524 deliver_host
= deliver_host_address
= NULL
;
525 deliver_domain
= save_deliver_domain
;
527 /* Wait for initial response, and send HELO. The smtp_write_command()
528 function leaves its command in big_buffer. This is used in error responses.
529 Initialize it in case the connection is rejected. */
531 Ustrcpy(big_buffer
, "initial connection");
533 /* Unless ssl-on-connect, wait for the initial greeting */
537 if (!smtps
|| (smtps
&& tls_out
.active
>= 0))
539 if (!(done
= smtp_read_response(&inblock
, responsebuffer
, sizeof(responsebuffer
), '2', callout
)))
540 goto RESPONSE_FAILED
;
542 /* Not worth checking greeting line for ESMTP support */
543 if (!(esmtp
= verify_check_this_host(&(ob
->hosts_avoid_esmtp
), NULL
,
544 host
->name
, host
->address
, NULL
) != OK
))
546 debug_printf("not sending EHLO (host matches hosts_avoid_esmtp)\n");
551 if (smtps
&& tls_out
.active
< 0) /* ssl-on-connect, first pass */
554 ob
->tls_tempfail_tryclear
= FALSE
;
556 else /* all other cases */
561 if (!(done
= smtp_write_command(&outblock
, FALSE
, "%s %s\r\n",
562 !esmtp
? "HELO" : lmtp
? "LHLO" : "EHLO", active_hostname
) >= 0))
564 if (!smtp_read_response(&inblock
, responsebuffer
, sizeof(responsebuffer
), '2', callout
))
566 if (errno
!= 0 || responsebuffer
[0] == 0 || lmtp
|| !esmtp
|| tls_out
.active
>= 0)
569 goto RESPONSE_FAILED
;
575 goto esmtp_retry
; /* fallback to HELO */
578 /* Set tls_offered if the response to EHLO specifies support for STARTTLS. */
580 if (esmtp
&& !suppress_tls
&& tls_out
.active
< 0)
582 if (regex_STARTTLS
== NULL
) regex_STARTTLS
=
583 regex_must_compile(US
"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE
, TRUE
);
585 tls_offered
= pcre_exec(regex_STARTTLS
, NULL
, CS responsebuffer
,
586 Ustrlen(responsebuffer
), 0, PCRE_EOPT
, NULL
, 0) >= 0;
593 /* If TLS is available on this connection attempt to
594 start up a TLS session, unless the host is in hosts_avoid_tls. If successful,
595 send another EHLO - the server may give a different answer in secure mode. We
596 use a separate buffer for reading the response to STARTTLS so that if it is
597 negative, the original EHLO data is available for subsequent analysis, should
598 the client not be required to use TLS. If the response is bad, copy the buffer
599 for error analysis. */
603 verify_check_this_host(&(ob
->hosts_avoid_tls
), NULL
, host
->name
,
604 host
->address
, NULL
) != OK
&&
605 verify_check_this_host(&(ob
->hosts_verify_avoid_tls
), NULL
, host
->name
,
606 host
->address
, NULL
) != OK
609 uschar buffer2
[4096];
611 && !(done
= smtp_write_command(&outblock
, FALSE
, "STARTTLS\r\n") >= 0))
614 /* If there is an I/O error, transmission of this message is deferred. If
615 there is a temporary rejection of STARRTLS and tls_tempfail_tryclear is
616 false, we also defer. However, if there is a temporary rejection of STARTTLS
617 and tls_tempfail_tryclear is true, or if there is an outright rejection of
618 STARTTLS, we carry on. This means we will try to send the message in clear,
619 unless the host is in hosts_require_tls (tested below). */
621 if (!smtps
&& !smtp_read_response(&inblock
, buffer2
, sizeof(buffer2
), '2',
622 ob
->command_timeout
))
624 if (errno
!= 0 || buffer2
[0] == 0 ||
625 (buffer2
[0] == '4' && !ob
->tls_tempfail_tryclear
))
627 Ustrncpy(responsebuffer
, buffer2
, sizeof(responsebuffer
));
629 goto RESPONSE_FAILED
;
633 /* STARTTLS accepted or ssl-on-connect: try to negotiate a TLS session. */
636 int rc
= tls_client_start(inblock
.sock
, host
, addr
,
637 ob
->tls_certificate
, ob
->tls_privatekey
,
639 ob
->tls_verify_certificates
, ob
->tls_crl
,
640 ob
->tls_require_ciphers
,
641 #ifdef EXPERIMENTAL_OCSP
642 ob
->hosts_require_ocsp
,
644 ob
->tls_dh_min_bits
, callout
,
645 ob
->tls_verify_hosts
, ob
->tls_try_verify_hosts
);
647 /* TLS negotiation failed; give an error. Try in clear on a new connection,
648 if the options permit it for this host. */
651 if (rc
== DEFER
&& ob
->tls_tempfail_tryclear
&& !smtps
&&
652 verify_check_this_host(&(ob
->hosts_require_tls
), NULL
, host
->name
,
653 host
->address
, NULL
) != OK
)
655 (void)close(inblock
.sock
);
656 log_write(0, LOG_MAIN
, "TLS session failure: delivering unencrypted "
657 "to %s [%s] (not in hosts_require_tls)", host
->name
, host
->address
);
659 goto tls_retry_connection
;
661 /*save_errno = ERRNO_TLSFAILURE;*/
662 /*message = US"failure while setting up TLS session";*/
668 /* TLS session is set up. Copy info for logging. */
669 addr
->cipher
= tls_out
.cipher
;
670 addr
->peerdn
= tls_out
.peerdn
;
672 /* For SMTPS we need to wait for the initial OK response, then do HELO. */
674 goto smtps_redo_greeting
;
676 /* For STARTTLS we need to redo EHLO */
681 /* If the host is required to use a secure channel, ensure that we have one. */
682 if (tls_out
.active
< 0)
683 if (verify_check_this_host(&(ob
->hosts_require_tls
), NULL
, host
->name
,
684 host
->address
, NULL
) == OK
)
686 /*save_errno = ERRNO_TLSREQUIRED;*/
687 log_write(0, LOG_MAIN
, "a TLS session is required for %s [%s], but %s",
688 host
->name
, host
->address
,
689 tls_offered
? "an attempt to start TLS failed" : "the server did not offer TLS support");
694 #endif /*SUPPORT_TLS*/
696 done
= TRUE
; /* so far so good; have response to HELO */
698 /*XXX the EHLO response would be analyzed here for IGNOREQUOTA, SIZE, PIPELINING */
700 /* For now, transport_filter by cutthrough-delivery is not supported */
701 /* Need proper integration with the proper transport mechanism. */
702 if (cutthrough_delivery
)
704 if (addr
->transport
->filter_command
)
706 cutthrough_delivery
= FALSE
;
707 HDEBUG(D_acl
|D_v
) debug_printf("Cutthrough cancelled by presence of transport filter\n");
711 cutthrough_delivery
= FALSE
;
712 HDEBUG(D_acl
|D_v
) debug_printf("Cutthrough cancelled by presence of DKIM signing\n");
720 /* Clear down of the TLS, SMTP and TCP layers on error is handled below. */
723 /* Failure to accept HELO is cached; this blocks the whole domain for all
724 senders. I/O errors and defer responses are not cached. */
728 *failure_ptr
= US
"mail"; /* At or before MAIL */
729 if (errno
== 0 && responsebuffer
[0] == '5')
731 setflag(addr
, af_verify_nsfail
);
732 new_domain_record
.result
= ccache_reject
;
736 /* If we haven't authenticated, but are required to, give up. */
739 else done
= smtp_auth(responsebuffer
, sizeof(responsebuffer
),
740 addr
, host
, ob
, esmtp
, &inblock
, &outblock
) == OK
&&
742 /* Copy AUTH info for logging */
743 ( (addr
->authenticator
= client_authenticator
),
744 (addr
->auth_id
= client_authenticated_id
),
746 /* Build a mail-AUTH string (re-using responsebuffer for convenience */
747 !smtp_mail_auth_str(responsebuffer
, sizeof(responsebuffer
), addr
, ob
)
750 ( (addr
->auth_sndr
= client_authenticated_sender
),
752 /* Send the MAIL command */
753 (smtp_write_command(&outblock
, FALSE
, "MAIL FROM:<%s>%s\r\n",
754 from_address
, responsebuffer
) >= 0)
757 smtp_read_response(&inblock
, responsebuffer
, sizeof(responsebuffer
),
760 /* If the host does not accept MAIL FROM:<>, arrange to cache this
761 information, but again, don't record anything for an I/O error or a defer. Do
762 not cache rejections of MAIL when a non-empty sender has been used, because
763 that blocks the whole domain for all senders. */
767 *failure_ptr
= US
"mail"; /* At or before MAIL */
768 if (errno
== 0 && responsebuffer
[0] == '5')
770 setflag(addr
, af_verify_nsfail
);
771 if (from_address
[0] == 0)
772 new_domain_record
.result
= ccache_reject_mfnull
;
776 /* Otherwise, proceed to check a "random" address (if required), then the
777 given address, and the postmaster address (if required). Between each check,
778 issue RSET, because some servers accept only one recipient after MAIL
781 Before doing this, set the result in the domain cache record to "accept",
782 unless its previous value was ccache_reject_mfnull. In that case, the domain
783 rejects MAIL FROM:<> and we want to continue to remember that. When that is
784 the case, we have got here only in the case of a recipient verification with
785 a non-null sender. */
789 new_domain_record
.result
=
790 (old_domain_cache_result
== ccache_reject_mfnull
)?
791 ccache_reject_mfnull
: ccache_accept
;
793 /* Do the random local part check first */
795 if (random_local_part
!= NULL
)
797 uschar randombuffer
[1024];
799 smtp_write_command(&outblock
, FALSE
,
800 "RCPT TO:<%.1000s@%.1000s>\r\n", random_local_part
,
801 addr
->domain
) >= 0 &&
802 smtp_read_response(&inblock
, randombuffer
,
803 sizeof(randombuffer
), '2', callout
);
805 /* Remember when we last did a random test */
807 new_domain_record
.random_stamp
= time(NULL
);
809 /* If accepted, we aren't going to do any further tests below. */
813 new_domain_record
.random_result
= ccache_accept
;
816 /* Otherwise, cache a real negative response, and get back to the right
817 state to send RCPT. Unless there's some problem such as a dropped
818 connection, we expect to succeed, because the commands succeeded above. */
822 if (randombuffer
[0] == '5')
823 new_domain_record
.random_result
= ccache_reject
;
826 smtp_write_command(&outblock
, FALSE
, "RSET\r\n") >= 0 &&
827 smtp_read_response(&inblock
, responsebuffer
, sizeof(responsebuffer
),
830 smtp_write_command(&outblock
, FALSE
, "MAIL FROM:<%s>\r\n",
831 from_address
) >= 0 &&
832 smtp_read_response(&inblock
, responsebuffer
, sizeof(responsebuffer
),
835 else done
= FALSE
; /* Some timeout/connection problem */
838 /* If the host is accepting all local parts, as determined by the "random"
839 check, we don't need to waste time doing any further checking. */
841 if (new_domain_record
.random_result
!= ccache_accept
&& done
)
843 /* Get the rcpt_include_affixes flag from the transport if there is one,
844 but assume FALSE if there is not. */
847 smtp_write_command(&outblock
, FALSE
, "RCPT TO:<%.1000s>\r\n",
848 transport_rcpt_address(addr
,
849 (addr
->transport
== NULL
)? FALSE
:
850 addr
->transport
->rcpt_include_affixes
)) >= 0 &&
851 smtp_read_response(&inblock
, responsebuffer
, sizeof(responsebuffer
),
855 new_address_record
.result
= ccache_accept
;
856 else if (errno
== 0 && responsebuffer
[0] == '5')
858 *failure_ptr
= US
"recipient";
859 new_address_record
.result
= ccache_reject
;
862 /* Do postmaster check if requested; if a full check is required, we
863 check for RCPT TO:<postmaster> (no domain) in accordance with RFC 821. */
865 if (done
&& pm_mailfrom
!= NULL
)
867 /*XXX not suitable for cutthrough - sequencing problems */
868 cutthrough_delivery
= FALSE
;
869 HDEBUG(D_acl
|D_v
) debug_printf("Cutthrough cancelled by presence of postmaster verify\n");
872 smtp_write_command(&outblock
, FALSE
, "RSET\r\n") >= 0 &&
873 smtp_read_response(&inblock
, responsebuffer
,
874 sizeof(responsebuffer
), '2', callout
) &&
876 smtp_write_command(&outblock
, FALSE
,
877 "MAIL FROM:<%s>\r\n", pm_mailfrom
) >= 0 &&
878 smtp_read_response(&inblock
, responsebuffer
,
879 sizeof(responsebuffer
), '2', callout
) &&
881 /* First try using the current domain */
884 smtp_write_command(&outblock
, FALSE
,
885 "RCPT TO:<postmaster@%.1000s>\r\n", addr
->domain
) >= 0 &&
886 smtp_read_response(&inblock
, responsebuffer
,
887 sizeof(responsebuffer
), '2', callout
)
892 /* If that doesn't work, and a full check is requested,
893 try without the domain. */
896 (options
& vopt_callout_fullpm
) != 0 &&
897 smtp_write_command(&outblock
, FALSE
,
898 "RCPT TO:<postmaster>\r\n") >= 0 &&
899 smtp_read_response(&inblock
, responsebuffer
,
900 sizeof(responsebuffer
), '2', callout
)
903 /* Sort out the cache record */
905 new_domain_record
.postmaster_stamp
= time(NULL
);
908 new_domain_record
.postmaster_result
= ccache_accept
;
909 else if (errno
== 0 && responsebuffer
[0] == '5')
911 *failure_ptr
= US
"postmaster";
912 setflag(addr
, af_verify_pmfail
);
913 new_domain_record
.postmaster_result
= ccache_reject
;
916 } /* Random not accepted */
917 } /* MAIL FROM: accepted */
919 /* For any failure of the main check, other than a negative response, we just
920 close the connection and carry on. We can identify a negative response by the
921 fact that errno is zero. For I/O errors it will be non-zero
923 Set up different error texts for logging and for sending back to the caller
924 as an SMTP response. Log in all cases, using a one-line format. For sender
925 callouts, give a full response to the caller, but for recipient callouts,
926 don't give the IP address because this may be an internal host whose identity
927 is not to be widely broadcast. */
931 if (errno
== ETIMEDOUT
)
933 HDEBUG(D_verify
) debug_printf("SMTP timeout\n");
938 if (*responsebuffer
== 0) Ustrcpy(responsebuffer
, US
"connection dropped");
941 string_sprintf("response to \"%s\" from %s [%s] was: %s",
942 big_buffer
, host
->name
, host
->address
,
943 string_printing(responsebuffer
));
945 addr
->user_message
= is_recipient
?
946 string_sprintf("Callout verification failed:\n%s", responsebuffer
)
948 string_sprintf("Called: %s\nSent: %s\nResponse: %s",
949 host
->address
, big_buffer
, responsebuffer
);
951 /* Hard rejection ends the process */
953 if (responsebuffer
[0] == '5') /* Address rejected */
961 /* End the SMTP conversation and close the connection. */
963 /* Cutthrough - on a successfull connect and recipient-verify with use-sender
964 and we have no cutthrough conn so far
965 here is where we want to leave the conn open */
966 if ( cutthrough_delivery
969 && (options
& (vopt_callout_recipsender
|vopt_callout_recippmaster
)) == vopt_callout_recipsender
970 && !random_local_part
975 cutthrough_fd
= outblock
.sock
; /* We assume no buffer in use in the outblock */
976 cutthrough_addr
= *addr
; /* Save the address_item for later logging */
977 cutthrough_addr
.host_used
= store_get(sizeof(host_item
));
978 cutthrough_addr
.host_used
->name
= host
->name
;
979 cutthrough_addr
.host_used
->address
= host
->address
;
980 cutthrough_addr
.host_used
->port
= port
;
982 *(cutthrough_addr
.parent
= store_get(sizeof(address_item
)))= *addr
->parent
;
983 ctblock
.buffer
= ctbuffer
;
984 ctblock
.buffersize
= sizeof(ctbuffer
);
985 ctblock
.ptr
= ctbuffer
;
986 /* ctblock.cmd_count = 0; ctblock.authenticating = FALSE; */
987 ctblock
.sock
= cutthrough_fd
;
991 /* Ensure no cutthrough on multiple address verifies */
992 if (options
& vopt_callout_recipsender
)
993 cancel_cutthrough_connection("multiple verify calls");
994 if (send_quit
) (void)smtp_write_command(&outblock
, FALSE
, "QUIT\r\n");
997 tls_close(FALSE
, TRUE
);
999 (void)close(inblock
.sock
);
1002 } /* Loop through all hosts, while !done */
1005 /* If we get here with done == TRUE, a successful callout happened, and yield
1006 will be set OK or FAIL according to the response to the RCPT command.
1007 Otherwise, we looped through the hosts but couldn't complete the business.
1008 However, there may be domain-specific information to cache in both cases.
1010 The value of the result field in the new_domain record is ccache_unknown if
1011 there was an error before or with MAIL FROM:, and errno was not zero,
1012 implying some kind of I/O error. We don't want to write the cache in that case.
1013 Otherwise the value is ccache_accept, ccache_reject, or ccache_reject_mfnull. */
1015 if (!callout_no_cache
&& new_domain_record
.result
!= ccache_unknown
)
1017 if ((dbm_file
= dbfn_open(US
"callout", O_RDWR
|O_CREAT
, &dbblock
, FALSE
))
1020 HDEBUG(D_verify
) debug_printf("callout cache: not available\n");
1024 (void)dbfn_write(dbm_file
, addr
->domain
, &new_domain_record
,
1025 (int)sizeof(dbdata_callout_cache
));
1026 HDEBUG(D_verify
) debug_printf("wrote callout cache domain record:\n"
1027 " result=%d postmaster=%d random=%d\n",
1028 new_domain_record
.result
,
1029 new_domain_record
.postmaster_result
,
1030 new_domain_record
.random_result
);
1034 /* If a definite result was obtained for the callout, cache it unless caching
1039 if (!callout_no_cache
&& new_address_record
.result
!= ccache_unknown
)
1041 if (dbm_file
== NULL
)
1042 dbm_file
= dbfn_open(US
"callout", O_RDWR
|O_CREAT
, &dbblock
, FALSE
);
1043 if (dbm_file
== NULL
)
1045 HDEBUG(D_verify
) debug_printf("no callout cache available\n");
1049 (void)dbfn_write(dbm_file
, address_key
, &new_address_record
,
1050 (int)sizeof(dbdata_callout_cache_address
));
1051 HDEBUG(D_verify
) debug_printf("wrote %s callout cache address record\n",
1052 (new_address_record
.result
== ccache_accept
)? "positive" : "negative");
1057 /* Failure to connect to any host, or any response other than 2xx or 5xx is a
1058 temporary error. If there was only one host, and a response was received, leave
1059 it alone if supplying details. Otherwise, give a generic response. */
1063 uschar
*dullmsg
= string_sprintf("Could not complete %s verify callout",
1064 is_recipient
? "recipient" : "sender");
1067 if (host_list
->next
!= NULL
|| addr
->message
== NULL
) addr
->message
= dullmsg
;
1069 addr
->user_message
= (!smtp_return_error_details
)? dullmsg
:
1070 string_sprintf("%s for <%s>.\n"
1071 "The mail server(s) for the domain may be temporarily unreachable, or\n"
1072 "they may be permanently unreachable from this server. In the latter case,\n%s",
1073 dullmsg
, addr
->address
,
1075 "the address will never be accepted."
1077 "you need to change the address or create an MX record for its domain\n"
1078 "if it is supposed to be generally accessible from the Internet.\n"
1079 "Talk to your mail administrator for details.");
1081 /* Force a specific error code */
1083 addr
->basic_errno
= ERRNO_CALLOUTDEFER
;
1086 /* Come here from within the cache-reading code on fast-track exit. */
1089 if (dbm_file
!= NULL
) dbfn_close(dbm_file
);
1095 /* Called after recipient-acl to get a cutthrough connection open when
1096 one was requested and a recipient-verify wasn't subsequently done.
1099 open_cutthrough_connection( address_item
* addr
)
1103 /* Use a recipient-verify-callout to set up the cutthrough connection. */
1104 /* We must use a copy of the address for verification, because it might
1108 HDEBUG(D_acl
) debug_printf("----------- start cutthrough setup ------------\n");
1109 (void) verify_address(&addr2
, NULL
,
1110 vopt_is_recipient
| vopt_callout_recipsender
| vopt_callout_no_cache
,
1111 CUTTHROUGH_CMD_TIMEOUT
, -1, -1,
1113 HDEBUG(D_acl
) debug_printf("----------- end cutthrough setup ------------\n");
1119 /* Send given number of bytes from the buffer */
1121 cutthrough_send(int n
)
1123 if(cutthrough_fd
< 0)
1128 (tls_out
.active
== cutthrough_fd
) ? tls_write(FALSE
, ctblock
.buffer
, n
) :
1130 send(cutthrough_fd
, ctblock
.buffer
, n
, 0) > 0
1133 transport_count
+= n
;
1134 ctblock
.ptr
= ctblock
.buffer
;
1138 HDEBUG(D_transport
|D_acl
) debug_printf("cutthrough_send failed: %s\n", strerror(errno
));
1145 _cutthrough_puts(uschar
* cp
, int n
)
1149 if(ctblock
.ptr
>= ctblock
.buffer
+ctblock
.buffersize
)
1150 if(!cutthrough_send(ctblock
.buffersize
))
1153 *ctblock
.ptr
++ = *cp
++;
1158 /* Buffered output of counted data block. Return boolean success */
1160 cutthrough_puts(uschar
* cp
, int n
)
1162 if (cutthrough_fd
< 0) return TRUE
;
1163 if (_cutthrough_puts(cp
, n
)) return TRUE
;
1164 cancel_cutthrough_connection("transmit failed");
1170 _cutthrough_flush_send( void )
1172 int n
= ctblock
.ptr
-ctblock
.buffer
;
1175 if(!cutthrough_send(n
))
1181 /* Send out any bufferred output. Return boolean success. */
1183 cutthrough_flush_send( void )
1185 if (_cutthrough_flush_send()) return TRUE
;
1186 cancel_cutthrough_connection("transmit failed");
1192 cutthrough_put_nl( void )
1194 return cutthrough_puts(US
"\r\n", 2);
1198 /* Get and check response from cutthrough target */
1200 cutthrough_response(char expect
, uschar
** copy
)
1202 smtp_inblock inblock
;
1203 uschar inbuffer
[4096];
1204 uschar responsebuffer
[4096];
1206 inblock
.buffer
= inbuffer
;
1207 inblock
.buffersize
= sizeof(inbuffer
);
1208 inblock
.ptr
= inbuffer
;
1209 inblock
.ptrend
= inbuffer
;
1210 inblock
.sock
= cutthrough_fd
;
1211 /* this relies on (inblock.sock == tls_out.active) */
1212 if(!smtp_read_response(&inblock
, responsebuffer
, sizeof(responsebuffer
), expect
, CUTTHROUGH_DATA_TIMEOUT
))
1213 cancel_cutthrough_connection("target timeout on read");
1218 *copy
= cp
= string_copy(responsebuffer
);
1219 /* Trim the trailing end of line */
1220 cp
+= Ustrlen(responsebuffer
);
1221 if(cp
> *copy
&& cp
[-1] == '\n') *--cp
= '\0';
1222 if(cp
> *copy
&& cp
[-1] == '\r') *--cp
= '\0';
1225 return responsebuffer
[0];
1229 /* Negotiate dataphase with the cutthrough target, returning success boolean */
1231 cutthrough_predata( void )
1233 if(cutthrough_fd
< 0)
1236 HDEBUG(D_transport
|D_acl
|D_v
) debug_printf(" SMTP>> DATA\n");
1237 cutthrough_puts(US
"DATA\r\n", 6);
1238 cutthrough_flush_send();
1240 /* Assume nothing buffered. If it was it gets ignored. */
1241 return cutthrough_response('3', NULL
) == '3';
1245 /* Buffered send of headers. Return success boolean. */
1246 /* Expands newlines to wire format (CR,NL). */
1247 /* Also sends header-terminating blank line. */
1249 cutthrough_headers_send( void )
1252 uschar
* cp1
, * cp2
;
1254 if(cutthrough_fd
< 0)
1257 for(h
= header_list
; h
!= NULL
; h
= h
->next
)
1258 if(h
->type
!= htype_old
&& h
->text
!= NULL
)
1259 for (cp1
= h
->text
; *cp1
&& (cp2
= Ustrchr(cp1
, '\n')); cp1
= cp2
+1)
1260 if( !cutthrough_puts(cp1
, cp2
-cp1
)
1261 || !cutthrough_put_nl())
1264 HDEBUG(D_transport
|D_acl
|D_v
) debug_printf(" SMTP>>(nl)\n");
1265 return cutthrough_put_nl();
1270 close_cutthrough_connection( const char * why
)
1272 if(cutthrough_fd
>= 0)
1274 /* We could be sending this after a bunch of data, but that is ok as
1275 the only way to cancel the transfer in dataphase is to drop the tcp
1276 conn before the final dot.
1278 ctblock
.ptr
= ctbuffer
;
1279 HDEBUG(D_transport
|D_acl
|D_v
) debug_printf(" SMTP>> QUIT\n");
1280 _cutthrough_puts(US
"QUIT\r\n", 6); /* avoid recursion */
1281 _cutthrough_flush_send();
1282 /* No wait for response */
1285 tls_close(FALSE
, TRUE
);
1287 (void)close(cutthrough_fd
);
1289 HDEBUG(D_acl
) debug_printf("----------- cutthrough shutdown (%s) ------------\n", why
);
1291 ctblock
.ptr
= ctbuffer
;
1295 cancel_cutthrough_connection( const char * why
)
1297 close_cutthrough_connection(why
);
1298 cutthrough_delivery
= FALSE
;
1304 /* Have senders final-dot. Send one to cutthrough target, and grab the response.
1305 Log an OK response as a transmission.
1306 Close the connection.
1307 Return smtp response-class digit.
1310 cutthrough_finaldot( void )
1312 HDEBUG(D_transport
|D_acl
|D_v
) debug_printf(" SMTP>> .\n");
1314 /* Assume data finshed with new-line */
1315 if(!cutthrough_puts(US
".", 1) || !cutthrough_put_nl() || !cutthrough_flush_send())
1316 return cutthrough_addr
.message
;
1318 switch(cutthrough_response('2', &cutthrough_addr
.message
))
1321 delivery_log(LOG_MAIN
, &cutthrough_addr
, (int)'>', NULL
);
1322 close_cutthrough_connection("delivered");
1326 delivery_log(LOG_MAIN
, &cutthrough_addr
, 0, US
"tmp-reject from cutthrough after DATA:");
1330 delivery_log(LOG_MAIN
|LOG_REJECT
, &cutthrough_addr
, 0, US
"rejected after DATA:");
1336 return cutthrough_addr
.message
;
1341 /*************************************************
1342 * Copy error to toplevel address *
1343 *************************************************/
1345 /* This function is used when a verify fails or defers, to ensure that the
1346 failure or defer information is in the original toplevel address. This applies
1347 when an address is redirected to a single new address, and the failure or
1348 deferral happens to the child address.
1351 vaddr the verify address item
1352 addr the final address item
1355 Returns: the value of YIELD
1359 copy_error(address_item
*vaddr
, address_item
*addr
, int yield
)
1363 vaddr
->message
= addr
->message
;
1364 vaddr
->user_message
= addr
->user_message
;
1365 vaddr
->basic_errno
= addr
->basic_errno
;
1366 vaddr
->more_errno
= addr
->more_errno
;
1367 vaddr
->p
.address_data
= addr
->p
.address_data
;
1368 copyflag(vaddr
, addr
, af_pass_message
);
1376 /**************************************************
1377 * printf that automatically handles TLS if needed *
1378 ***************************************************/
1380 /* This function is used by verify_address() as a substitute for all fprintf()
1381 calls; a direct fprintf() will not produce output in a TLS SMTP session, such
1382 as a response to an EXPN command. smtp_in.c makes smtp_printf available but
1383 that assumes that we always use the smtp_out FILE* when not using TLS or the
1384 ssl buffer when we are. Instead we take a FILE* parameter and check to see if
1385 that is smtp_out; if so, smtp_printf() with TLS support, otherwise regular
1389 f the candidate FILE* to write to
1390 format format string
1391 ... optional arguments
1397 static void PRINTF_FUNCTION(2,3)
1398 respond_printf(FILE *f
, const char *format
, ...)
1402 va_start(ap
, format
);
1403 if (smtp_out
&& (f
== smtp_out
))
1404 smtp_vprintf(format
, ap
);
1406 vfprintf(f
, format
, ap
);
1412 /*************************************************
1413 * Verify an email address *
1414 *************************************************/
1416 /* This function is used both for verification (-bv and at other times) and
1417 address testing (-bt), which is indicated by address_test_mode being set.
1420 vaddr contains the address to verify; the next field in this block
1422 f if not NULL, write the result to this file
1423 options various option bits:
1424 vopt_fake_sender => this sender verify is not for the real
1425 sender (it was verify=sender=xxxx or an address from a
1426 header line) - rewriting must not change sender_address
1427 vopt_is_recipient => this is a recipient address, otherwise
1428 it's a sender address - this affects qualification and
1429 rewriting and messages from callouts
1430 vopt_qualify => qualify an unqualified address; else error
1431 vopt_expn => called from SMTP EXPN command
1432 vopt_success_on_redirect => when a new address is generated
1433 the verification instantly succeeds
1435 These ones are used by do_callout() -- the options variable
1438 vopt_callout_fullpm => if postmaster check, do full one
1439 vopt_callout_no_cache => don't use callout cache
1440 vopt_callout_random => do the "random" thing
1441 vopt_callout_recipsender => use real sender for recipient
1442 vopt_callout_recippmaster => use postmaster for recipient
1444 callout if > 0, specifies that callout is required, and gives timeout
1445 for individual commands
1446 callout_overall if > 0, gives overall timeout for the callout function;
1447 if < 0, a default is used (see do_callout())
1448 callout_connect the connection timeout for callouts
1449 se_mailfrom when callout is requested to verify a sender, use this
1450 in MAIL FROM; NULL => ""
1451 pm_mailfrom when callout is requested, if non-NULL, do the postmaster
1452 thing and use this as the sender address (may be "")
1454 routed if not NULL, set TRUE if routing succeeded, so we can
1455 distinguish between routing failed and callout failed
1457 Returns: OK address verified
1458 FAIL address failed to verify
1459 DEFER can't tell at present
1463 verify_address(address_item
*vaddr
, FILE *f
, int options
, int callout
,
1464 int callout_overall
, int callout_connect
, uschar
*se_mailfrom
,
1465 uschar
*pm_mailfrom
, BOOL
*routed
)
1468 BOOL full_info
= (f
== NULL
)? FALSE
: (debug_selector
!= 0);
1469 BOOL is_recipient
= (options
& vopt_is_recipient
) != 0;
1470 BOOL expn
= (options
& vopt_expn
) != 0;
1471 BOOL success_on_redirect
= (options
& vopt_success_on_redirect
) != 0;
1474 int verify_type
= expn
? v_expn
:
1475 address_test_mode
? v_none
:
1476 is_recipient
? v_recipient
: v_sender
;
1477 address_item
*addr_list
;
1478 address_item
*addr_new
= NULL
;
1479 address_item
*addr_remote
= NULL
;
1480 address_item
*addr_local
= NULL
;
1481 address_item
*addr_succeed
= NULL
;
1482 uschar
**failure_ptr
= is_recipient
?
1483 &recipient_verify_failure
: &sender_verify_failure
;
1484 uschar
*ko_prefix
, *cr
;
1485 uschar
*address
= vaddr
->address
;
1486 uschar
*save_sender
;
1487 uschar null_sender
[] = { 0 }; /* Ensure writeable memory */
1489 /* Clear, just in case */
1491 *failure_ptr
= NULL
;
1493 /* Set up a prefix and suffix for error message which allow us to use the same
1494 output statements both in EXPN mode (where an SMTP response is needed) and when
1495 debugging with an output file. */
1499 ko_prefix
= US
"553 ";
1502 else ko_prefix
= cr
= US
"";
1504 /* Add qualify domain if permitted; otherwise an unqualified address fails. */
1506 if (parse_find_at(address
) == NULL
)
1508 if ((options
& vopt_qualify
) == 0)
1511 respond_printf(f
, "%sA domain is required for \"%s\"%s\n",
1512 ko_prefix
, address
, cr
);
1513 *failure_ptr
= US
"qualify";
1516 address
= rewrite_address_qualify(address
, is_recipient
);
1521 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
1522 debug_printf("%s %s\n", address_test_mode
? "Testing" : "Verifying", address
);
1525 /* Rewrite and report on it. Clear the domain and local part caches - these
1526 may have been set by domains and local part tests during an ACL. */
1528 if (global_rewrite_rules
!= NULL
)
1530 uschar
*old
= address
;
1531 address
= rewrite_address(address
, is_recipient
, FALSE
,
1532 global_rewrite_rules
, rewrite_existflags
);
1535 for (i
= 0; i
< (MAX_NAMED_LIST
* 2)/32; i
++) vaddr
->localpart_cache
[i
] = 0;
1536 for (i
= 0; i
< (MAX_NAMED_LIST
* 2)/32; i
++) vaddr
->domain_cache
[i
] = 0;
1537 if (f
!= NULL
&& !expn
) fprintf(f
, "Address rewritten as: %s\n", address
);
1541 /* If this is the real sender address, we must update sender_address at
1542 this point, because it may be referred to in the routers. */
1544 if ((options
& (vopt_fake_sender
|vopt_is_recipient
)) == 0)
1545 sender_address
= address
;
1547 /* If the address was rewritten to <> no verification can be done, and we have
1548 to return OK. This rewriting is permitted only for sender addresses; for other
1549 addresses, such rewriting fails. */
1551 if (address
[0] == 0) return OK
;
1553 /* Flip the legacy TLS-related variables over to the outbound set in case
1554 they're used in the context of a transport used by verification. Reset them
1555 at exit from this routine. */
1557 modify_variable(US
"tls_bits", &tls_out
.bits
);
1558 modify_variable(US
"tls_certificate_verified", &tls_out
.certificate_verified
);
1559 modify_variable(US
"tls_cipher", &tls_out
.cipher
);
1560 modify_variable(US
"tls_peerdn", &tls_out
.peerdn
);
1561 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
1562 modify_variable(US
"tls_sni", &tls_out
.sni
);
1565 /* Save a copy of the sender address for re-instating if we change it to <>
1566 while verifying a sender address (a nice bit of self-reference there). */
1568 save_sender
= sender_address
;
1570 /* Update the address structure with the possibly qualified and rewritten
1571 address. Set it up as the starting address on the chain of new addresses. */
1573 vaddr
->address
= address
;
1576 /* We need a loop, because an address can generate new addresses. We must also
1577 cope with generated pipes and files at the top level. (See also the code and
1578 comment in deliver.c.) However, it is usually the case that the router for
1579 user's .forward files has its verify flag turned off.
1581 If an address generates more than one child, the loop is used only when
1582 full_info is set, and this can only be set locally. Remote enquiries just get
1583 information about the top level address, not anything that it generated. */
1585 while (addr_new
!= NULL
)
1588 address_item
*addr
= addr_new
;
1590 addr_new
= addr
->next
;
1595 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
1596 debug_printf("Considering %s\n", addr
->address
);
1599 /* Handle generated pipe, file or reply addresses. We don't get these
1600 when handling EXPN, as it does only one level of expansion. */
1602 if (testflag(addr
, af_pfr
))
1609 if (addr
->address
[0] == '>')
1611 allow
= testflag(addr
, af_allow_reply
);
1612 fprintf(f
, "%s -> mail %s", addr
->parent
->address
, addr
->address
+ 1);
1616 allow
= (addr
->address
[0] == '|')?
1617 testflag(addr
, af_allow_pipe
) : testflag(addr
, af_allow_file
);
1618 fprintf(f
, "%s -> %s", addr
->parent
->address
, addr
->address
);
1621 if (addr
->basic_errno
== ERRNO_BADTRANSPORT
)
1622 fprintf(f
, "\n*** Error in setting up pipe, file, or autoreply:\n"
1623 "%s\n", addr
->message
);
1625 fprintf(f
, "\n transport = %s\n", addr
->transport
->name
);
1627 fprintf(f
, " *** forbidden ***\n");
1632 /* Just in case some router parameter refers to it. */
1634 return_path
= (addr
->p
.errors_address
!= NULL
)?
1635 addr
->p
.errors_address
: sender_address
;
1637 /* Split the address into domain and local part, handling the %-hack if
1638 necessary, and then route it. While routing a sender address, set
1639 $sender_address to <> because that is what it will be if we were trying to
1640 send a bounce to the sender. */
1642 if (routed
!= NULL
) *routed
= FALSE
;
1643 if ((rc
= deliver_split_address(addr
)) == OK
)
1645 if (!is_recipient
) sender_address
= null_sender
;
1646 rc
= route_address(addr
, &addr_local
, &addr_remote
, &addr_new
,
1647 &addr_succeed
, verify_type
);
1648 sender_address
= save_sender
; /* Put back the real sender */
1651 /* If routing an address succeeded, set the flag that remembers, for use when
1652 an ACL cached a sender verify (in case a callout fails). Then if routing set
1653 up a list of hosts or the transport has a host list, and the callout option
1654 is set, and we aren't in a host checking run, do the callout verification,
1655 and set another flag that notes that a callout happened. */
1659 if (routed
!= NULL
) *routed
= TRUE
;
1662 host_item
*host_list
= addr
->host_list
;
1664 /* Make up some data for use in the case where there is no remote
1667 transport_feedback tf
= {
1668 NULL
, /* interface (=> any) */
1669 US
"smtp", /* port */
1670 US
"smtp", /* protocol */
1672 US
"$smtp_active_hostname", /* helo_data */
1673 FALSE
, /* hosts_override */
1674 FALSE
, /* hosts_randomize */
1675 FALSE
, /* gethostbyname */
1676 TRUE
, /* qualify_single */
1677 FALSE
/* search_parents */
1680 /* If verification yielded a remote transport, we want to use that
1681 transport's options, so as to mimic what would happen if we were really
1682 sending a message to this address. */
1684 if (addr
->transport
!= NULL
&& !addr
->transport
->info
->local
)
1686 (void)(addr
->transport
->setup
)(addr
->transport
, addr
, &tf
, 0, 0, NULL
);
1688 /* If the transport has hosts and the router does not, or if the
1689 transport is configured to override the router's hosts, we must build a
1690 host list of the transport's hosts, and find the IP addresses */
1692 if (tf
.hosts
!= NULL
&& (host_list
== NULL
|| tf
.hosts_override
))
1695 uschar
*save_deliver_domain
= deliver_domain
;
1696 uschar
*save_deliver_localpart
= deliver_localpart
;
1698 host_list
= NULL
; /* Ignore the router's hosts */
1700 deliver_domain
= addr
->domain
;
1701 deliver_localpart
= addr
->local_part
;
1702 s
= expand_string(tf
.hosts
);
1703 deliver_domain
= save_deliver_domain
;
1704 deliver_localpart
= save_deliver_localpart
;
1708 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to expand list of hosts "
1709 "\"%s\" in %s transport for callout: %s", tf
.hosts
,
1710 addr
->transport
->name
, expand_string_message
);
1715 uschar
*canonical_name
;
1716 host_item
*host
, *nexthost
;
1717 host_build_hostlist(&host_list
, s
, tf
.hosts_randomize
);
1719 /* Just ignore failures to find a host address. If we don't manage
1720 to find any addresses, the callout will defer. Note that more than
1721 one address may be found for a single host, which will result in
1722 additional host items being inserted into the chain. Hence we must
1723 save the next host first. */
1725 flags
= HOST_FIND_BY_A
;
1726 if (tf
.qualify_single
) flags
|= HOST_FIND_QUALIFY_SINGLE
;
1727 if (tf
.search_parents
) flags
|= HOST_FIND_SEARCH_PARENTS
;
1729 for (host
= host_list
; host
!= NULL
; host
= nexthost
)
1731 nexthost
= host
->next
;
1732 if (tf
.gethostbyname
||
1733 string_is_ip_address(host
->name
, NULL
) != 0)
1734 (void)host_find_byname(host
, NULL
, flags
, &canonical_name
, TRUE
);
1736 (void)host_find_bydns(host
, NULL
, flags
, NULL
, NULL
, NULL
,
1737 &canonical_name
, NULL
);
1743 /* Can only do a callout if we have at least one host! If the callout
1744 fails, it will have set ${sender,recipient}_verify_failure. */
1746 if (host_list
!= NULL
)
1748 HDEBUG(D_verify
) debug_printf("Attempting full verification using callout\n");
1749 if (host_checking
&& !host_checking_callout
)
1752 debug_printf("... callout omitted by default when host testing\n"
1753 "(Use -bhc if you want the callouts to happen.)\n");
1758 deliver_set_expansions(addr
);
1760 rc
= do_callout(addr
, host_list
, &tf
, callout
, callout_overall
,
1761 callout_connect
, options
, se_mailfrom
, pm_mailfrom
);
1766 HDEBUG(D_verify
) debug_printf("Cannot do callout: neither router nor "
1767 "transport provided a host list\n");
1772 /* Otherwise, any failure is a routing failure */
1774 else *failure_ptr
= US
"route";
1776 /* A router may return REROUTED if it has set up a child address as a result
1777 of a change of domain name (typically from widening). In this case we always
1778 want to continue to verify the new child. */
1780 if (rc
== REROUTED
) continue;
1782 /* Handle hard failures */
1789 address_item
*p
= addr
->parent
;
1791 respond_printf(f
, "%s%s %s", ko_prefix
,
1792 full_info
? addr
->address
: address
,
1793 address_test_mode
? "is undeliverable" : "failed to verify");
1794 if (!expn
&& admin_user
)
1796 if (addr
->basic_errno
> 0)
1797 respond_printf(f
, ": %s", strerror(addr
->basic_errno
));
1798 if (addr
->message
!= NULL
)
1799 respond_printf(f
, ": %s", addr
->message
);
1802 /* Show parents iff doing full info */
1804 if (full_info
) while (p
!= NULL
)
1806 respond_printf(f
, "%s\n <-- %s", cr
, p
->address
);
1809 respond_printf(f
, "%s\n", cr
);
1811 cancel_cutthrough_connection("routing hard fail");
1815 yield
= copy_error(vaddr
, addr
, FAIL
);
1823 else if (rc
== DEFER
)
1828 address_item
*p
= addr
->parent
;
1829 respond_printf(f
, "%s%s cannot be resolved at this time", ko_prefix
,
1830 full_info
? addr
->address
: address
);
1831 if (!expn
&& admin_user
)
1833 if (addr
->basic_errno
> 0)
1834 respond_printf(f
, ": %s", strerror(addr
->basic_errno
));
1835 if (addr
->message
!= NULL
)
1836 respond_printf(f
, ": %s", addr
->message
);
1837 else if (addr
->basic_errno
<= 0)
1838 respond_printf(f
, ": unknown error");
1841 /* Show parents iff doing full info */
1843 if (full_info
) while (p
!= NULL
)
1845 respond_printf(f
, "%s\n <-- %s", cr
, p
->address
);
1848 respond_printf(f
, "%s\n", cr
);
1850 cancel_cutthrough_connection("routing soft fail");
1854 yield
= copy_error(vaddr
, addr
, DEFER
);
1857 else if (yield
== OK
) yield
= DEFER
;
1860 /* If we are handling EXPN, we do not want to continue to route beyond
1861 the top level (whose address is in "address"). */
1865 uschar
*ok_prefix
= US
"250-";
1866 if (addr_new
== NULL
)
1868 if (addr_local
== NULL
&& addr_remote
== NULL
)
1869 respond_printf(f
, "250 mail to <%s> is discarded\r\n", address
);
1871 respond_printf(f
, "250 <%s>\r\n", address
);
1873 else while (addr_new
!= NULL
)
1875 address_item
*addr2
= addr_new
;
1876 addr_new
= addr2
->next
;
1877 if (addr_new
== NULL
) ok_prefix
= US
"250 ";
1878 respond_printf(f
, "%s<%s>\r\n", ok_prefix
, addr2
->address
);
1884 /* Successful routing other than EXPN. */
1888 /* Handle successful routing when short info wanted. Otherwise continue for
1889 other (generated) addresses. Short info is the operational case. Full info
1890 can be requested only when debug_selector != 0 and a file is supplied.
1892 There is a conflict between the use of aliasing as an alternate email
1893 address, and as a sort of mailing list. If an alias turns the incoming
1894 address into just one address (e.g. J.Caesar->jc44) you may well want to
1895 carry on verifying the generated address to ensure it is valid when
1896 checking incoming mail. If aliasing generates multiple addresses, you
1897 probably don't want to do this. Exim therefore treats the generation of
1898 just a single new address as a special case, and continues on to verify the
1899 generated address. */
1901 if (!full_info
&& /* Stop if short info wanted AND */
1902 (((addr_new
== NULL
|| /* No new address OR */
1903 addr_new
->next
!= NULL
|| /* More than one new address OR */
1904 testflag(addr_new
, af_pfr
))) /* New address is pfr */
1906 (addr_new
!= NULL
&& /* At least one new address AND */
1907 success_on_redirect
))) /* success_on_redirect is set */
1909 if (f
!= NULL
) fprintf(f
, "%s %s\n", address
,
1910 address_test_mode
? "is deliverable" : "verified");
1912 /* If we have carried on to verify a child address, we want the value
1913 of $address_data to be that of the child */
1915 vaddr
->p
.address_data
= addr
->p
.address_data
;
1920 } /* Loop for generated addresses */
1922 /* Display the full results of the successful routing, including any generated
1923 addresses. Control gets here only when full_info is set, which requires f not
1924 to be NULL, and this occurs only when a top-level verify is called with the
1925 debugging switch on.
1927 If there are no local and no remote addresses, and there were no pipes, files,
1928 or autoreplies, and there were no errors or deferments, the message is to be
1929 discarded, usually because of the use of :blackhole: in an alias file. */
1931 if (allok
&& addr_local
== NULL
&& addr_remote
== NULL
)
1933 fprintf(f
, "mail to %s is discarded\n", address
);
1937 for (addr_list
= addr_local
, i
= 0; i
< 2; addr_list
= addr_remote
, i
++)
1939 while (addr_list
!= NULL
)
1941 address_item
*addr
= addr_list
;
1942 address_item
*p
= addr
->parent
;
1943 addr_list
= addr
->next
;
1945 fprintf(f
, "%s", CS addr
->address
);
1946 #ifdef EXPERIMENTAL_SRS
1947 if(addr
->p
.srs_sender
)
1948 fprintf(f
, " [srs = %s]", addr
->p
.srs_sender
);
1951 /* If the address is a duplicate, show something about it. */
1953 if (!testflag(addr
, af_pfr
))
1956 if ((tnode
= tree_search(tree_duplicates
, addr
->unique
)) != NULL
)
1957 fprintf(f
, " [duplicate, would not be delivered]");
1958 else tree_add_duplicate(addr
->unique
, addr
);
1961 /* Now show its parents */
1965 fprintf(f
, "\n <-- %s", p
->address
);
1970 /* Show router, and transport */
1972 fprintf(f
, "router = %s, ", addr
->router
->name
);
1973 fprintf(f
, "transport = %s\n", (addr
->transport
== NULL
)? US
"unset" :
1974 addr
->transport
->name
);
1976 /* Show any hosts that are set up by a router unless the transport
1977 is going to override them; fiddle a bit to get a nice format. */
1979 if (addr
->host_list
!= NULL
&& addr
->transport
!= NULL
&&
1980 !addr
->transport
->overrides_hosts
)
1985 for (h
= addr
->host_list
; h
!= NULL
; h
= h
->next
)
1987 int len
= Ustrlen(h
->name
);
1988 if (len
> maxlen
) maxlen
= len
;
1989 len
= (h
->address
!= NULL
)? Ustrlen(h
->address
) : 7;
1990 if (len
> maxaddlen
) maxaddlen
= len
;
1992 for (h
= addr
->host_list
; h
!= NULL
; h
= h
->next
)
1994 int len
= Ustrlen(h
->name
);
1995 fprintf(f
, " host %s ", h
->name
);
1996 while (len
++ < maxlen
) fprintf(f
, " ");
1997 if (h
->address
!= NULL
)
1999 fprintf(f
, "[%s] ", h
->address
);
2000 len
= Ustrlen(h
->address
);
2002 else if (!addr
->transport
->info
->local
) /* Omit [unknown] for local */
2004 fprintf(f
, "[unknown] ");
2008 while (len
++ < maxaddlen
) fprintf(f
," ");
2009 if (h
->mx
>= 0) fprintf(f
, "MX=%d", h
->mx
);
2010 if (h
->port
!= PORT_NONE
) fprintf(f
, " port=%d", h
->port
);
2011 if (h
->status
== hstatus_unusable
) fprintf(f
, " ** unusable **");
2018 /* Yield will be DEFER or FAIL if any one address has, only for full_info (which is
2019 the -bv or -bt case). */
2023 modify_variable(US
"tls_bits", &tls_in
.bits
);
2024 modify_variable(US
"tls_certificate_verified", &tls_in
.certificate_verified
);
2025 modify_variable(US
"tls_cipher", &tls_in
.cipher
);
2026 modify_variable(US
"tls_peerdn", &tls_in
.peerdn
);
2027 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
2028 modify_variable(US
"tls_sni", &tls_in
.sni
);
2037 /*************************************************
2038 * Check headers for syntax errors *
2039 *************************************************/
2041 /* This function checks those header lines that contain addresses, and verifies
2042 that all the addresses therein are syntactially correct.
2045 msgptr where to put an error message
2052 verify_check_headers(uschar
**msgptr
)
2058 for (h
= header_list
; h
!= NULL
&& yield
== OK
; h
= h
->next
)
2060 if (h
->type
!= htype_from
&&
2061 h
->type
!= htype_reply_to
&&
2062 h
->type
!= htype_sender
&&
2063 h
->type
!= htype_to
&&
2064 h
->type
!= htype_cc
&&
2065 h
->type
!= htype_bcc
)
2068 colon
= Ustrchr(h
->text
, ':');
2070 while (isspace(*s
)) s
++;
2072 /* Loop for multiple addresses in the header, enabling group syntax. Note
2073 that we have to reset this after the header has been scanned. */
2075 parse_allow_group
= TRUE
;
2079 uschar
*ss
= parse_find_address_end(s
, FALSE
);
2080 uschar
*recipient
, *errmess
;
2081 int terminator
= *ss
;
2082 int start
, end
, domain
;
2084 /* Temporarily terminate the string at this point, and extract the
2085 operative address within, allowing group syntax. */
2088 recipient
= parse_extract_address(s
,&errmess
,&start
,&end
,&domain
,FALSE
);
2091 /* Permit an unqualified address only if the message is local, or if the
2092 sending host is configured to be permitted to send them. */
2094 if (recipient
!= NULL
&& domain
== 0)
2096 if (h
->type
== htype_from
|| h
->type
== htype_sender
)
2098 if (!allow_unqualified_sender
) recipient
= NULL
;
2102 if (!allow_unqualified_recipient
) recipient
= NULL
;
2104 if (recipient
== NULL
) errmess
= US
"unqualified address not permitted";
2107 /* It's an error if no address could be extracted, except for the special
2108 case of an empty address. */
2110 if (recipient
== NULL
&& Ustrcmp(errmess
, "empty address") != 0)
2112 uschar
*verb
= US
"is";
2117 /* Arrange not to include any white space at the end in the
2118 error message or the header name. */
2120 while (t
> s
&& isspace(t
[-1])) t
--;
2121 while (tt
> h
->text
&& isspace(tt
[-1])) tt
--;
2123 /* Add the address that failed to the error message, since in a
2124 header with very many addresses it is sometimes hard to spot
2125 which one is at fault. However, limit the amount of address to
2126 quote - cases have been seen where, for example, a missing double
2127 quote in a humungous To: header creates an "address" that is longer
2128 than string_sprintf can handle. */
2137 *msgptr
= string_printing(
2138 string_sprintf("%s: failing address in \"%.*s:\" header %s: %.*s",
2139 errmess
, tt
- h
->text
, h
->text
, verb
, len
, s
));
2142 break; /* Out of address loop */
2145 /* Advance to the next address */
2147 s
= ss
+ (terminator
? 1:0);
2148 while (isspace(*s
)) s
++;
2149 } /* Next address */
2151 parse_allow_group
= FALSE
;
2152 parse_found_group
= FALSE
;
2153 } /* Next header unless yield has been set FALSE */
2160 /*************************************************
2161 * Check for blind recipients *
2162 *************************************************/
2164 /* This function checks that every (envelope) recipient is mentioned in either
2165 the To: or Cc: header lines, thus detecting blind carbon copies.
2167 There are two ways of scanning that could be used: either scan the header lines
2168 and tick off the recipients, or scan the recipients and check the header lines.
2169 The original proposed patch did the former, but I have chosen to do the latter,
2170 because (a) it requires no memory and (b) will use fewer resources when there
2171 are many addresses in To: and/or Cc: and only one or two envelope recipients.
2174 Returns: OK if there are no blind recipients
2175 FAIL if there is at least one blind recipient
2179 verify_check_notblind(void)
2182 for (i
= 0; i
< recipients_count
; i
++)
2186 uschar
*address
= recipients_list
[i
].address
;
2188 for (h
= header_list
; !found
&& h
!= NULL
; h
= h
->next
)
2192 if (h
->type
!= htype_to
&& h
->type
!= htype_cc
) continue;
2194 colon
= Ustrchr(h
->text
, ':');
2196 while (isspace(*s
)) s
++;
2198 /* Loop for multiple addresses in the header, enabling group syntax. Note
2199 that we have to reset this after the header has been scanned. */
2201 parse_allow_group
= TRUE
;
2205 uschar
*ss
= parse_find_address_end(s
, FALSE
);
2206 uschar
*recipient
,*errmess
;
2207 int terminator
= *ss
;
2208 int start
, end
, domain
;
2210 /* Temporarily terminate the string at this point, and extract the
2211 operative address within, allowing group syntax. */
2214 recipient
= parse_extract_address(s
,&errmess
,&start
,&end
,&domain
,FALSE
);
2217 /* If we found a valid recipient that has a domain, compare it with the
2218 envelope recipient. Local parts are compared case-sensitively, domains
2219 case-insensitively. By comparing from the start with length "domain", we
2220 include the "@" at the end, which ensures that we are comparing the whole
2221 local part of each address. */
2223 if (recipient
!= NULL
&& domain
!= 0)
2225 found
= Ustrncmp(recipient
, address
, domain
) == 0 &&
2226 strcmpic(recipient
+ domain
, address
+ domain
) == 0;
2230 /* Advance to the next address */
2232 s
= ss
+ (terminator
? 1:0);
2233 while (isspace(*s
)) s
++;
2234 } /* Next address */
2236 parse_allow_group
= FALSE
;
2237 parse_found_group
= FALSE
;
2238 } /* Next header (if found is false) */
2240 if (!found
) return FAIL
;
2241 } /* Next recipient */
2248 /*************************************************
2249 * Find if verified sender *
2250 *************************************************/
2252 /* Usually, just a single address is verified as the sender of the message.
2253 However, Exim can be made to verify other addresses as well (often related in
2254 some way), and this is useful in some environments. There may therefore be a
2255 chain of such addresses that have previously been tested. This function finds
2256 whether a given address is on the chain.
2258 Arguments: the address to be verified
2259 Returns: pointer to an address item, or NULL
2263 verify_checked_sender(uschar
*sender
)
2266 for (addr
= sender_verified_list
; addr
!= NULL
; addr
= addr
->next
)
2267 if (Ustrcmp(sender
, addr
->address
) == 0) break;
2275 /*************************************************
2276 * Get valid header address *
2277 *************************************************/
2279 /* Scan the originator headers of the message, looking for an address that
2280 verifies successfully. RFC 822 says:
2282 o The "Sender" field mailbox should be sent notices of
2283 any problems in transport or delivery of the original
2284 messages. If there is no "Sender" field, then the
2285 "From" field mailbox should be used.
2287 o If the "Reply-To" field exists, then the reply should
2288 go to the addresses indicated in that field and not to
2289 the address(es) indicated in the "From" field.
2291 So we check a Sender field if there is one, else a Reply_to field, else a From
2292 field. As some strange messages may have more than one of these fields,
2293 especially if they are resent- fields, check all of them if there is more than
2297 user_msgptr points to where to put a user error message
2298 log_msgptr points to where to put a log error message
2299 callout timeout for callout check (passed to verify_address())
2300 callout_overall overall callout timeout (ditto)
2301 callout_connect connect callout timeout (ditto)
2302 se_mailfrom mailfrom for verify; NULL => ""
2303 pm_mailfrom sender for pm callout check (passed to verify_address())
2304 options callout options (passed to verify_address())
2305 verrno where to put the address basic_errno
2307 If log_msgptr is set to something without setting user_msgptr, the caller
2308 normally uses log_msgptr for both things.
2310 Returns: result of the verification attempt: OK, FAIL, or DEFER;
2311 FAIL is given if no appropriate headers are found
2315 verify_check_header_address(uschar
**user_msgptr
, uschar
**log_msgptr
,
2316 int callout
, int callout_overall
, int callout_connect
, uschar
*se_mailfrom
,
2317 uschar
*pm_mailfrom
, int options
, int *verrno
)
2319 static int header_types
[] = { htype_sender
, htype_reply_to
, htype_from
};
2324 for (i
= 0; i
< 3 && !done
; i
++)
2327 for (h
= header_list
; h
!= NULL
&& !done
; h
= h
->next
)
2329 int terminator
, new_ok
;
2330 uschar
*s
, *ss
, *endname
;
2332 if (h
->type
!= header_types
[i
]) continue;
2333 s
= endname
= Ustrchr(h
->text
, ':') + 1;
2335 /* Scan the addresses in the header, enabling group syntax. Note that we
2336 have to reset this after the header has been scanned. */
2338 parse_allow_group
= TRUE
;
2342 address_item
*vaddr
;
2344 while (isspace(*s
) || *s
== ',') s
++;
2345 if (*s
== 0) break; /* End of header */
2347 ss
= parse_find_address_end(s
, FALSE
);
2349 /* The terminator is a comma or end of header, but there may be white
2350 space preceding it (including newline for the last address). Move back
2351 past any white space so we can check against any cached envelope sender
2352 address verifications. */
2354 while (isspace(ss
[-1])) ss
--;
2358 HDEBUG(D_verify
) debug_printf("verifying %.*s header address %s\n",
2359 (int)(endname
- h
->text
), h
->text
, s
);
2361 /* See if we have already verified this address as an envelope sender,
2362 and if so, use the previous answer. */
2364 vaddr
= verify_checked_sender(s
);
2366 if (vaddr
!= NULL
&& /* Previously checked */
2367 (callout
<= 0 || /* No callout needed; OR */
2368 vaddr
->special_action
> 256)) /* Callout was done */
2370 new_ok
= vaddr
->special_action
& 255;
2371 HDEBUG(D_verify
) debug_printf("previously checked as envelope sender\n");
2372 *ss
= terminator
; /* Restore shortened string */
2375 /* Otherwise we run the verification now. We must restore the shortened
2376 string before running the verification, so the headers are correct, in
2377 case there is any rewriting. */
2381 int start
, end
, domain
;
2382 uschar
*address
= parse_extract_address(s
, log_msgptr
, &start
, &end
,
2387 /* If we found an empty address, just carry on with the next one, but
2388 kill the message. */
2390 if (address
== NULL
&& Ustrcmp(*log_msgptr
, "empty address") == 0)
2397 /* If verification failed because of a syntax error, fail this
2398 function, and ensure that the failing address gets added to the error
2401 if (address
== NULL
)
2404 while (ss
> s
&& isspace(ss
[-1])) ss
--;
2405 *log_msgptr
= string_sprintf("syntax error in '%.*s' header when "
2406 "scanning for sender: %s in \"%.*s\"",
2407 endname
- h
->text
, h
->text
, *log_msgptr
, ss
- s
, s
);
2413 /* Else go ahead with the sender verification. But it isn't *the*
2414 sender of the message, so set vopt_fake_sender to stop sender_address
2415 being replaced after rewriting or qualification. */
2419 vaddr
= deliver_make_addr(address
, FALSE
);
2420 new_ok
= verify_address(vaddr
, NULL
, options
| vopt_fake_sender
,
2421 callout
, callout_overall
, callout_connect
, se_mailfrom
,
2426 /* We now have the result, either newly found, or cached. If we are
2427 giving out error details, set a specific user error. This means that the
2428 last of these will be returned to the user if all three fail. We do not
2429 set a log message - the generic one below will be used. */
2433 *verrno
= vaddr
->basic_errno
;
2434 if (smtp_return_error_details
)
2436 *user_msgptr
= string_sprintf("Rejected after DATA: "
2437 "could not verify \"%.*s\" header address\n%s: %s",
2438 endname
- h
->text
, h
->text
, vaddr
->address
, vaddr
->message
);
2442 /* Success or defer */
2451 if (new_ok
== DEFER
) yield
= DEFER
;
2453 /* Move on to any more addresses in the header */
2456 } /* Next address */
2458 parse_allow_group
= FALSE
;
2459 parse_found_group
= FALSE
;
2460 } /* Next header, unless done */
2461 } /* Next header type unless done */
2463 if (yield
== FAIL
&& *log_msgptr
== NULL
)
2464 *log_msgptr
= US
"there is no valid sender in any header line";
2466 if (yield
== DEFER
&& *log_msgptr
== NULL
)
2467 *log_msgptr
= US
"all attempts to verify a sender in a header line deferred";
2475 /*************************************************
2476 * Get RFC 1413 identification *
2477 *************************************************/
2479 /* Attempt to get an id from the sending machine via the RFC 1413 protocol. If
2480 the timeout is set to zero, then the query is not done. There may also be lists
2481 of hosts and nets which are exempt. To guard against malefactors sending
2482 non-printing characters which could, for example, disrupt a message's headers,
2483 make sure the string consists of printing characters only.
2486 port the port to connect to; usually this is IDENT_PORT (113), but when
2487 running in the test harness with -bh a different value is used.
2491 Side effect: any received ident value is put in sender_ident (NULL otherwise)
2495 verify_get_ident(int port
)
2497 int sock
, host_af
, qlen
;
2498 int received_sender_port
, received_interface_port
, n
;
2500 uschar buffer
[2048];
2502 /* Default is no ident. Check whether we want to do an ident check for this
2505 sender_ident
= NULL
;
2506 if (rfc1413_query_timeout
<= 0 || verify_check_host(&rfc1413_hosts
) != OK
)
2509 DEBUG(D_ident
) debug_printf("doing ident callback\n");
2511 /* Set up a connection to the ident port of the remote host. Bind the local end
2512 to the incoming interface address. If the sender host address is an IPv6
2513 address, the incoming interface address will also be IPv6. */
2515 host_af
= (Ustrchr(sender_host_address
, ':') == NULL
)? AF_INET
: AF_INET6
;
2516 sock
= ip_socket(SOCK_STREAM
, host_af
);
2517 if (sock
< 0) return;
2519 if (ip_bind(sock
, host_af
, interface_address
, 0) < 0)
2521 DEBUG(D_ident
) debug_printf("bind socket for ident failed: %s\n",
2526 if (ip_connect(sock
, host_af
, sender_host_address
, port
, rfc1413_query_timeout
)
2529 if (errno
== ETIMEDOUT
&& (log_extra_selector
& LX_ident_timeout
) != 0)
2531 log_write(0, LOG_MAIN
, "ident connection to %s timed out",
2532 sender_host_address
);
2536 DEBUG(D_ident
) debug_printf("ident connection to %s failed: %s\n",
2537 sender_host_address
, strerror(errno
));
2542 /* Construct and send the query. */
2544 sprintf(CS buffer
, "%d , %d\r\n", sender_host_port
, interface_port
);
2545 qlen
= Ustrlen(buffer
);
2546 if (send(sock
, buffer
, qlen
, 0) < 0)
2548 DEBUG(D_ident
) debug_printf("ident send failed: %s\n", strerror(errno
));
2552 /* Read a response line. We put it into the rest of the buffer, using several
2553 recv() calls if necessary. */
2561 int size
= sizeof(buffer
) - (p
- buffer
);
2563 if (size
<= 0) goto END_OFF
; /* Buffer filled without seeing \n. */
2564 count
= ip_recv(sock
, p
, size
, rfc1413_query_timeout
);
2565 if (count
<= 0) goto END_OFF
; /* Read error or EOF */
2567 /* Scan what we just read, to see if we have reached the terminating \r\n. Be
2568 generous, and accept a plain \n terminator as well. The only illegal
2571 for (pp
= p
; pp
< p
+ count
; pp
++)
2573 if (*pp
== 0) goto END_OFF
; /* Zero octet not allowed */
2576 if (pp
[-1] == '\r') pp
--;
2578 goto GOT_DATA
; /* Break out of both loops */
2582 /* Reached the end of the data without finding \n. Let the loop continue to
2583 read some more, if there is room. */
2590 /* We have received a line of data. Check it carefully. It must start with the
2591 same two port numbers that we sent, followed by data as defined by the RFC. For
2594 12345 , 25 : USERID : UNIX :root
2596 However, the amount of white space may be different to what we sent. In the
2597 "osname" field there may be several sub-fields, comma separated. The data we
2598 actually want to save follows the third colon. Some systems put leading spaces
2599 in it - we discard those. */
2601 if (sscanf(CS buffer
+ qlen
, "%d , %d%n", &received_sender_port
,
2602 &received_interface_port
, &n
) != 2 ||
2603 received_sender_port
!= sender_host_port
||
2604 received_interface_port
!= interface_port
)
2607 p
= buffer
+ qlen
+ n
;
2608 while(isspace(*p
)) p
++;
2609 if (*p
++ != ':') goto END_OFF
;
2610 while(isspace(*p
)) p
++;
2611 if (Ustrncmp(p
, "USERID", 6) != 0) goto END_OFF
;
2613 while(isspace(*p
)) p
++;
2614 if (*p
++ != ':') goto END_OFF
;
2615 while (*p
!= 0 && *p
!= ':') p
++;
2616 if (*p
++ == 0) goto END_OFF
;
2617 while(isspace(*p
)) p
++;
2618 if (*p
== 0) goto END_OFF
;
2620 /* The rest of the line is the data we want. We turn it into printing
2621 characters when we save it, so that it cannot mess up the format of any logging
2622 or Received: lines into which it gets inserted. We keep a maximum of 127
2625 sender_ident
= string_printing(string_copyn(p
, 127));
2626 DEBUG(D_ident
) debug_printf("sender_ident = %s\n", sender_ident
);
2636 /*************************************************
2637 * Match host to a single host-list item *
2638 *************************************************/
2640 /* This function compares a host (name or address) against a single item
2641 from a host list. The host name gets looked up if it is needed and is not
2642 already known. The function is called from verify_check_this_host() via
2643 match_check_list(), which is why most of its arguments are in a single block.
2646 arg the argument block (see below)
2647 ss the host-list item
2648 valueptr where to pass back looked up data, or NULL
2649 error for error message when returning ERROR
2652 host_name (a) the host name, or
2653 (b) NULL, implying use sender_host_name and
2654 sender_host_aliases, looking them up if required, or
2655 (c) the empty string, meaning that only IP address matches
2657 host_address the host address
2658 host_ipv4 the IPv4 address taken from an IPv6 one
2662 DEFER lookup deferred
2663 ERROR (a) failed to find the host name or IP address, or
2664 (b) unknown lookup type specified, or
2665 (c) host name encountered when only IP addresses are
2670 check_host(void *arg
, uschar
*ss
, uschar
**valueptr
, uschar
**error
)
2672 check_host_block
*cb
= (check_host_block
*)arg
;
2675 BOOL iplookup
= FALSE
;
2676 BOOL isquery
= FALSE
;
2677 BOOL isiponly
= cb
->host_name
!= NULL
&& cb
->host_name
[0] == 0;
2682 /* Optimize for the special case when the pattern is "*". */
2684 if (*ss
== '*' && ss
[1] == 0) return OK
;
2686 /* If the pattern is empty, it matches only in the case when there is no host -
2687 this can occur in ACL checking for SMTP input using the -bs option. In this
2688 situation, the host address is the empty string. */
2690 if (cb
->host_address
[0] == 0) return (*ss
== 0)? OK
: FAIL
;
2691 if (*ss
== 0) return FAIL
;
2693 /* If the pattern is precisely "@" then match against the primary host name,
2694 provided that host name matching is permitted; if it's "@[]" match against the
2695 local host's IP addresses. */
2701 if (isiponly
) return ERROR
;
2702 ss
= primary_hostname
;
2704 else if (Ustrcmp(ss
, "@[]") == 0)
2706 ip_address_item
*ip
;
2707 for (ip
= host_find_interfaces(); ip
!= NULL
; ip
= ip
->next
)
2708 if (Ustrcmp(ip
->address
, cb
->host_address
) == 0) return OK
;
2713 /* If the pattern is an IP address, optionally followed by a bitmask count, do
2714 a (possibly masked) comparision with the current IP address. */
2716 if (string_is_ip_address(ss
, &maskoffset
) != 0)
2717 return (host_is_in_net(cb
->host_address
, ss
, maskoffset
)? OK
: FAIL
);
2719 /* The pattern is not an IP address. A common error that people make is to omit
2720 one component of an IPv4 address, either by accident, or believing that, for
2721 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,
2722 which it isn't. (Those applications that do accept 1.2.3 as an IP address
2723 interpret it as 1.2.0.3 because the final component becomes 16-bit - this is an
2724 ancient specification.) To aid in debugging these cases, we give a specific
2725 error if the pattern contains only digits and dots or contains a slash preceded
2726 only by digits and dots (a slash at the start indicates a file name and of
2727 course slashes may be present in lookups, but not preceded only by digits and
2730 for (t
= ss
; isdigit(*t
) || *t
== '.'; t
++);
2731 if (*t
== 0 || (*t
== '/' && t
!= ss
))
2733 *error
= US
"malformed IPv4 address or address mask";
2737 /* See if there is a semicolon in the pattern */
2739 semicolon
= Ustrchr(ss
, ';');
2741 /* If we are doing an IP address only match, then all lookups must be IP
2742 address lookups, even if there is no "net-". */
2746 iplookup
= semicolon
!= NULL
;
2749 /* Otherwise, if the item is of the form net[n]-lookup;<file|query> then it is
2750 a lookup on a masked IP network, in textual form. We obey this code even if we
2751 have already set iplookup, so as to skip over the "net-" prefix and to set the
2752 mask length. The net- stuff really only applies to single-key lookups where the
2753 key is implicit. For query-style lookups the key is specified in the query.
2754 From release 4.30, the use of net- for query style is no longer needed, but we
2755 retain it for backward compatibility. */
2757 if (Ustrncmp(ss
, "net", 3) == 0 && semicolon
!= NULL
)
2760 for (t
= ss
+ 3; isdigit(*t
); t
++) mlen
= mlen
* 10 + *t
- '0';
2761 if (mlen
== 0 && t
== ss
+3) mlen
= -1; /* No mask supplied */
2762 iplookup
= (*t
++ == '-');
2766 /* Do the IP address lookup if that is indeed what we have */
2774 uschar
*filename
, *key
, *result
;
2777 /* Find the search type */
2779 search_type
= search_findtype(t
, semicolon
- t
);
2781 if (search_type
< 0) log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "%s",
2782 search_error_message
);
2784 /* Adjust parameters for the type of lookup. For a query-style lookup, there
2785 is no file name, and the "key" is just the query. For query-style with a file
2786 name, we have to fish the file off the start of the query. For a single-key
2787 lookup, the key is the current IP address, masked appropriately, and
2788 reconverted to text form, with the mask appended. For IPv6 addresses, specify
2789 dot separators instead of colons, except when the lookup type is "iplsearch".
2792 if (mac_islookup(search_type
, lookup_absfilequery
))
2794 filename
= semicolon
+ 1;
2796 while (*key
!= 0 && !isspace(*key
)) key
++;
2797 filename
= string_copyn(filename
, key
- filename
);
2798 while (isspace(*key
)) key
++;
2800 else if (mac_islookup(search_type
, lookup_querystyle
))
2803 key
= semicolon
+ 1;
2805 else /* Single-key style */
2807 int sep
= (Ustrcmp(lookup_list
[search_type
]->name
, "iplsearch") == 0)?
2809 insize
= host_aton(cb
->host_address
, incoming
);
2810 host_mask(insize
, incoming
, mlen
);
2811 (void)host_nmtoa(insize
, incoming
, mlen
, buffer
, sep
);
2813 filename
= semicolon
+ 1;
2816 /* Now do the actual lookup; note that there is no search_close() because
2817 of the caching arrangements. */
2819 handle
= search_open(filename
, search_type
, 0, NULL
, NULL
);
2820 if (handle
== NULL
) log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "%s",
2821 search_error_message
);
2822 result
= search_find(handle
, filename
, key
, -1, NULL
, 0, 0, NULL
);
2823 if (valueptr
!= NULL
) *valueptr
= result
;
2824 return (result
!= NULL
)? OK
: search_find_defer
? DEFER
: FAIL
;
2827 /* The pattern is not an IP address or network reference of any kind. That is,
2828 it is a host name pattern. If this is an IP only match, there's an error in the
2833 *error
= US
"cannot match host name in match_ip list";
2837 /* Check the characters of the pattern to see if they comprise only letters,
2838 digits, full stops, and hyphens (the constituents of domain names). Allow
2839 underscores, as they are all too commonly found. Sigh. Also, if
2840 allow_utf8_domains is set, allow top-bit characters. */
2842 for (t
= ss
; *t
!= 0; t
++)
2843 if (!isalnum(*t
) && *t
!= '.' && *t
!= '-' && *t
!= '_' &&
2844 (!allow_utf8_domains
|| *t
< 128)) break;
2846 /* If the pattern is a complete domain name, with no fancy characters, look up
2847 its IP address and match against that. Note that a multi-homed host will add
2848 items to the chain. */
2859 rc
= host_find_byname(&h
, NULL
, HOST_FIND_QUALIFY_SINGLE
, NULL
, FALSE
);
2860 if (rc
== HOST_FOUND
|| rc
== HOST_FOUND_LOCAL
)
2863 for (hh
= &h
; hh
!= NULL
; hh
= hh
->next
)
2865 if (host_is_in_net(hh
->address
, cb
->host_address
, 0)) return OK
;
2869 if (rc
== HOST_FIND_AGAIN
) return DEFER
;
2870 *error
= string_sprintf("failed to find IP address for %s", ss
);
2874 /* Almost all subsequent comparisons require the host name, and can be done
2875 using the general string matching function. When this function is called for
2876 outgoing hosts, the name is always given explicitly. If it is NULL, it means we
2877 must use sender_host_name and its aliases, looking them up if necessary. */
2879 if (cb
->host_name
!= NULL
) /* Explicit host name given */
2880 return match_check_string(cb
->host_name
, ss
, -1, TRUE
, TRUE
, TRUE
,
2883 /* Host name not given; in principle we need the sender host name and its
2884 aliases. However, for query-style lookups, we do not need the name if the
2885 query does not contain $sender_host_name. From release 4.23, a reference to
2886 $sender_host_name causes it to be looked up, so we don't need to do the lookup
2889 if ((semicolon
= Ustrchr(ss
, ';')) != NULL
)
2892 int partial
, affixlen
, starflags
, id
;
2895 id
= search_findtype_partial(ss
, &partial
, &affix
, &affixlen
, &starflags
);
2898 if (id
< 0) /* Unknown lookup type */
2900 log_write(0, LOG_MAIN
|LOG_PANIC
, "%s in host list item \"%s\"",
2901 search_error_message
, ss
);
2904 isquery
= mac_islookup(id
, lookup_querystyle
|lookup_absfilequery
);
2909 switch(match_check_string(US
"", ss
, -1, TRUE
, TRUE
, TRUE
, valueptr
))
2912 case DEFER
: return DEFER
;
2913 default: return FAIL
;
2917 /* Not a query-style lookup; must ensure the host name is present, and then we
2918 do a check on the name and all its aliases. */
2920 if (sender_host_name
== NULL
)
2922 HDEBUG(D_host_lookup
)
2923 debug_printf("sender host name required, to match against %s\n", ss
);
2924 if (host_lookup_failed
|| host_name_lookup() != OK
)
2926 *error
= string_sprintf("failed to find host name for %s",
2927 sender_host_address
);;
2930 host_build_sender_fullhost();
2933 /* Match on the sender host name, using the general matching function */
2935 switch(match_check_string(sender_host_name
, ss
, -1, TRUE
, TRUE
, TRUE
,
2939 case DEFER
: return DEFER
;
2942 /* If there are aliases, try matching on them. */
2944 aliases
= sender_host_aliases
;
2945 while (*aliases
!= NULL
)
2947 switch(match_check_string(*aliases
++, ss
, -1, TRUE
, TRUE
, TRUE
, valueptr
))
2950 case DEFER
: return DEFER
;
2959 /*************************************************
2960 * Check a specific host matches a host list *
2961 *************************************************/
2963 /* This function is passed a host list containing items in a number of
2964 different formats and the identity of a host. Its job is to determine whether
2965 the given host is in the set of hosts defined by the list. The host name is
2966 passed as a pointer so that it can be looked up if needed and not already
2967 known. This is commonly the case when called from verify_check_host() to check
2968 an incoming connection. When called from elsewhere the host name should usually
2971 This function is now just a front end to match_check_list(), which runs common
2972 code for scanning a list. We pass it the check_host() function to perform a
2976 listptr pointer to the host list
2977 cache_bits pointer to cache for named lists, or NULL
2978 host_name the host name or NULL, implying use sender_host_name and
2979 sender_host_aliases, looking them up if required
2980 host_address the IP address
2981 valueptr if not NULL, data from a lookup is passed back here
2983 Returns: OK if the host is in the defined set
2984 FAIL if the host is not in the defined set,
2985 DEFER if a data lookup deferred (not a host lookup)
2987 If the host name was needed in order to make a comparison, and could not be
2988 determined from the IP address, the result is FAIL unless the item
2989 "+allow_unknown" was met earlier in the list, in which case OK is returned. */
2992 verify_check_this_host(uschar
**listptr
, unsigned int *cache_bits
,
2993 uschar
*host_name
, uschar
*host_address
, uschar
**valueptr
)
2996 unsigned int *local_cache_bits
= cache_bits
;
2997 uschar
*save_host_address
= deliver_host_address
;
2998 check_host_block cb
;
2999 cb
.host_name
= host_name
;
3000 cb
.host_address
= host_address
;
3002 if (valueptr
!= NULL
) *valueptr
= NULL
;
3004 /* If the host address starts off ::ffff: it is an IPv6 address in
3005 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3008 cb
.host_ipv4
= (Ustrncmp(host_address
, "::ffff:", 7) == 0)?
3009 host_address
+ 7 : host_address
;
3011 /* During the running of the check, put the IP address into $host_address. In
3012 the case of calls from the smtp transport, it will already be there. However,
3013 in other calls (e.g. when testing ignore_target_hosts), it won't. Just to be on
3014 the safe side, any existing setting is preserved, though as I write this
3015 (November 2004) I can't see any cases where it is actually needed. */
3017 deliver_host_address
= host_address
;
3018 rc
= match_check_list(
3019 listptr
, /* the list */
3020 0, /* separator character */
3021 &hostlist_anchor
, /* anchor pointer */
3022 &local_cache_bits
, /* cache pointer */
3023 check_host
, /* function for testing */
3024 &cb
, /* argument for function */
3025 MCL_HOST
, /* type of check */
3026 (host_address
== sender_host_address
)?
3027 US
"host" : host_address
, /* text for debugging */
3028 valueptr
); /* where to pass back data */
3029 deliver_host_address
= save_host_address
;
3036 /*************************************************
3037 * Check the remote host matches a list *
3038 *************************************************/
3040 /* This is a front end to verify_check_this_host(), created because checking
3041 the remote host is a common occurrence. With luck, a good compiler will spot
3042 the tail recursion and optimize it. If there's no host address, this is
3043 command-line SMTP input - check against an empty string for the address.
3046 listptr pointer to the host list
3048 Returns: the yield of verify_check_this_host(),
3049 i.e. OK, FAIL, or DEFER
3053 verify_check_host(uschar
**listptr
)
3055 return verify_check_this_host(listptr
, sender_host_cache
, NULL
,
3056 (sender_host_address
== NULL
)? US
"" : sender_host_address
, NULL
);
3063 /*************************************************
3064 * Invert an IP address *
3065 *************************************************/
3067 /* Originally just used for DNS xBL lists, now also used for the
3068 reverse_ip expansion operator.
3071 buffer where to put the answer
3072 address the address to invert
3076 invert_address(uschar
*buffer
, uschar
*address
)
3079 uschar
*bptr
= buffer
;
3081 /* If this is an IPv4 address mapped into IPv6 format, adjust the pointer
3082 to the IPv4 part only. */
3084 if (Ustrncmp(address
, "::ffff:", 7) == 0) address
+= 7;
3086 /* Handle IPv4 address: when HAVE_IPV6 is false, the result of host_aton() is
3089 if (host_aton(address
, bin
) == 1)
3093 for (i
= 0; i
< 4; i
++)
3095 sprintf(CS bptr
, "%d.", x
& 255);
3096 while (*bptr
) bptr
++;
3101 /* Handle IPv6 address. Actually, as far as I know, there are no IPv6 addresses
3102 in any DNS black lists, and the format in which they will be looked up is
3103 unknown. This is just a guess. */
3109 for (j
= 3; j
>= 0; j
--)
3112 for (i
= 0; i
< 8; i
++)
3114 sprintf(CS bptr
, "%x.", x
& 15);
3115 while (*bptr
) bptr
++;
3122 /* Remove trailing period -- this is needed so that both arbitrary
3123 dnsbl keydomains and inverted addresses may be combined with the
3124 same format string, "%s.%s" */
3131 /*************************************************
3132 * Perform a single dnsbl lookup *
3133 *************************************************/
3135 /* This function is called from verify_check_dnsbl() below. It is also called
3136 recursively from within itself when domain and domain_txt are different
3137 pointers, in order to get the TXT record from the alternate domain.
3140 domain the outer dnsbl domain
3141 domain_txt alternate domain to lookup TXT record on success; when the
3142 same domain is to be used, domain_txt == domain (that is,
3143 the pointers must be identical, not just the text)
3144 keydomain the current keydomain (for debug message)
3145 prepend subdomain to lookup (like keydomain, but
3146 reversed if IP address)
3147 iplist the list of matching IP addresses, or NULL for "any"
3148 bitmask true if bitmask matching is wanted
3149 match_type condition for 'succeed' result
3150 0 => Any RR in iplist (=)
3151 1 => No RR in iplist (!=)
3152 2 => All RRs in iplist (==)
3153 3 => Some RRs not in iplist (!==)
3154 the two bits are defined as MT_NOT and MT_ALL
3155 defer_return what to return for a defer
3157 Returns: OK if lookup succeeded
3162 one_check_dnsbl(uschar
*domain
, uschar
*domain_txt
, uschar
*keydomain
,
3163 uschar
*prepend
, uschar
*iplist
, BOOL bitmask
, int match_type
,
3169 dnsbl_cache_block
*cb
;
3170 int old_pool
= store_pool
;
3171 uschar query
[256]; /* DNS domain max length */
3173 /* Construct the specific query domainname */
3175 if (!string_format(query
, sizeof(query
), "%s.%s", prepend
, domain
))
3177 log_write(0, LOG_MAIN
|LOG_PANIC
, "dnslist query is too long "
3178 "(ignored): %s...", query
);
3182 /* Look for this query in the cache. */
3184 t
= tree_search(dnsbl_cache
, query
);
3186 /* If not cached from a previous lookup, we must do a DNS lookup, and
3187 cache the result in permanent memory. */
3191 store_pool
= POOL_PERM
;
3193 /* Set up a tree entry to cache the lookup */
3195 t
= store_get(sizeof(tree_node
) + Ustrlen(query
));
3196 Ustrcpy(t
->name
, query
);
3197 t
->data
.ptr
= cb
= store_get(sizeof(dnsbl_cache_block
));
3198 (void)tree_insertnode(&dnsbl_cache
, t
);
3200 /* Do the DNS loopup . */
3202 HDEBUG(D_dnsbl
) debug_printf("new DNS lookup for %s\n", query
);
3203 cb
->rc
= dns_basic_lookup(&dnsa
, query
, T_A
);
3204 cb
->text_set
= FALSE
;
3208 /* If the lookup succeeded, cache the RHS address. The code allows for
3209 more than one address - this was for complete generality and the possible
3210 use of A6 records. However, A6 records have been reduced to experimental
3211 status (August 2001) and may die out. So they may never get used at all,
3212 let alone in dnsbl records. However, leave the code here, just in case.
3214 Quite apart from one A6 RR generating multiple addresses, there are DNS
3215 lists that return more than one A record, so we must handle multiple
3216 addresses generated in that way as well. */
3218 if (cb
->rc
== DNS_SUCCEED
)
3221 dns_address
**addrp
= &(cb
->rhs
);
3222 for (rr
= dns_next_rr(&dnsa
, &dnss
, RESET_ANSWERS
);
3224 rr
= dns_next_rr(&dnsa
, &dnss
, RESET_NEXT
))
3226 if (rr
->type
== T_A
)
3228 dns_address
*da
= dns_address_from_rr(&dnsa
, rr
);
3232 while (da
->next
!= NULL
) da
= da
->next
;
3233 addrp
= &(da
->next
);
3238 /* If we didn't find any A records, change the return code. This can
3239 happen when there is a CNAME record but there are no A records for what
3242 if (cb
->rhs
== NULL
) cb
->rc
= DNS_NODATA
;
3245 store_pool
= old_pool
;
3248 /* Previous lookup was cached */
3252 HDEBUG(D_dnsbl
) debug_printf("using result of previous DNS lookup\n");
3256 /* We now have the result of the DNS lookup, either newly done, or cached
3257 from a previous call. If the lookup succeeded, check against the address
3258 list if there is one. This may be a positive equality list (introduced by
3259 "="), a negative equality list (introduced by "!="), a positive bitmask
3260 list (introduced by "&"), or a negative bitmask list (introduced by "!&").*/
3262 if (cb
->rc
== DNS_SUCCEED
)
3264 dns_address
*da
= NULL
;
3265 uschar
*addlist
= cb
->rhs
->address
;
3267 /* For A and AAAA records, there may be multiple addresses from multiple
3268 records. For A6 records (currently not expected to be used) there may be
3269 multiple addresses from a single record. */
3271 for (da
= cb
->rhs
->next
; da
!= NULL
; da
= da
->next
)
3272 addlist
= string_sprintf("%s, %s", addlist
, da
->address
);
3274 HDEBUG(D_dnsbl
) debug_printf("DNS lookup for %s succeeded (yielding %s)\n",
3277 /* Address list check; this can be either for equality, or via a bitmask.
3278 In the latter case, all the bits must match. */
3282 for (da
= cb
->rhs
; da
!= NULL
; da
= da
->next
)
3286 uschar
*ptr
= iplist
;
3289 /* Handle exact matching */
3293 while ((res
= string_nextinlist(&ptr
, &ipsep
, ip
, sizeof(ip
))) != NULL
)
3295 if (Ustrcmp(CS da
->address
, ip
) == 0) break;
3299 /* Handle bitmask matching */
3306 /* At present, all known DNS blocking lists use A records, with
3307 IPv4 addresses on the RHS encoding the information they return. I
3308 wonder if this will linger on as the last vestige of IPv4 when IPv6
3309 is ubiquitous? Anyway, for now we use paranoia code to completely
3310 ignore IPv6 addresses. The default mask is 0, which always matches.
3311 We change this only for IPv4 addresses in the list. */
3313 if (host_aton(da
->address
, address
) == 1) mask
= address
[0];
3315 /* Scan the returned addresses, skipping any that are IPv6 */
3317 while ((res
= string_nextinlist(&ptr
, &ipsep
, ip
, sizeof(ip
))) != NULL
)
3319 if (host_aton(ip
, address
) != 1) continue;
3320 if ((address
[0] & mask
) == address
[0]) break;
3326 (a) An IP address in an any ('=') list matched, or
3327 (b) No IP address in an all ('==') list matched
3329 then we're done searching. */
3331 if (((match_type
& MT_ALL
) != 0) == (res
== NULL
)) break;
3334 /* If da == NULL, either
3336 (a) No IP address in an any ('=') list matched, or
3337 (b) An IP address in an all ('==') list didn't match
3339 so behave as if the DNSBL lookup had not succeeded, i.e. the host is not on
3342 if ((match_type
== MT_NOT
|| match_type
== MT_ALL
) != (da
== NULL
))
3350 res
= US
"was no match";
3353 res
= US
"was an exclude match";
3356 res
= US
"was an IP address that did not match";
3359 res
= US
"were no IP addresses that did not match";
3362 debug_printf("=> but we are not accepting this block class because\n");
3363 debug_printf("=> there %s for %s%c%s\n",
3365 ((match_type
& MT_ALL
) == 0)? "" : "=",
3366 bitmask
? '&' : '=', iplist
);
3372 /* Either there was no IP list, or the record matched, implying that the
3373 domain is on the list. We now want to find a corresponding TXT record. If an
3374 alternate domain is specified for the TXT record, call this function
3375 recursively to look that up; this has the side effect of re-checking that
3376 there is indeed an A record at the alternate domain. */
3378 if (domain_txt
!= domain
)
3379 return one_check_dnsbl(domain_txt
, domain_txt
, keydomain
, prepend
, NULL
,
3380 FALSE
, match_type
, defer_return
);
3382 /* If there is no alternate domain, look up a TXT record in the main domain
3383 if it has not previously been cached. */
3387 cb
->text_set
= TRUE
;
3388 if (dns_basic_lookup(&dnsa
, query
, T_TXT
) == DNS_SUCCEED
)
3391 for (rr
= dns_next_rr(&dnsa
, &dnss
, RESET_ANSWERS
);
3393 rr
= dns_next_rr(&dnsa
, &dnss
, RESET_NEXT
))
3394 if (rr
->type
== T_TXT
) break;
3397 int len
= (rr
->data
)[0];
3398 if (len
> 511) len
= 127;
3399 store_pool
= POOL_PERM
;
3400 cb
->text
= string_sprintf("%.*s", len
, (const uschar
*)(rr
->data
+1));
3401 store_pool
= old_pool
;
3406 dnslist_value
= addlist
;
3407 dnslist_text
= cb
->text
;
3411 /* There was a problem with the DNS lookup */
3413 if (cb
->rc
!= DNS_NOMATCH
&& cb
->rc
!= DNS_NODATA
)
3415 log_write(L_dnslist_defer
, LOG_MAIN
,
3416 "DNS list lookup defer (probably timeout) for %s: %s", query
,
3417 (defer_return
== OK
)? US
"assumed in list" :
3418 (defer_return
== FAIL
)? US
"assumed not in list" :
3419 US
"returned DEFER");
3420 return defer_return
;
3423 /* No entry was found in the DNS; continue for next domain */
3427 debug_printf("DNS lookup for %s failed\n", query
);
3428 debug_printf("=> that means %s is not listed at %s\n",
3438 /*************************************************
3439 * Check host against DNS black lists *
3440 *************************************************/
3442 /* This function runs checks against a list of DNS black lists, until one
3443 matches. Each item on the list can be of the form
3445 domain=ip-address/key
3447 The domain is the right-most domain that is used for the query, for example,
3448 blackholes.mail-abuse.org. If the IP address is present, there is a match only
3449 if the DNS lookup returns a matching IP address. Several addresses may be
3450 given, comma-separated, for example: x.y.z=127.0.0.1,127.0.0.2.
3452 If no key is given, what is looked up in the domain is the inverted IP address
3453 of the current client host. If a key is given, it is used to construct the
3454 domain for the lookup. For example:
3456 dsn.rfc-ignorant.org/$sender_address_domain
3458 After finding a match in the DNS, the domain is placed in $dnslist_domain, and
3459 then we check for a TXT record for an error message, and if found, save its
3460 value in $dnslist_text. We also cache everything in a tree, to optimize
3463 The TXT record is normally looked up in the same domain as the A record, but
3464 when many lists are combined in a single DNS domain, this will not be a very
3465 specific message. It is possible to specify a different domain for looking up
3466 TXT records; this is given before the main domain, comma-separated. For
3469 dnslists = http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
3470 socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3
3472 The caching ensures that only one lookup in dnsbl.sorbs.net is done.
3474 Note: an address for testing RBL is 192.203.178.39
3475 Note: an address for testing DUL is 192.203.178.4
3476 Note: a domain for testing RFCI is example.tld.dsn.rfc-ignorant.org
3479 listptr the domain/address/data list
3481 Returns: OK successful lookup (i.e. the address is on the list), or
3482 lookup deferred after +include_unknown
3483 FAIL name not found, or no data found for the given type, or
3484 lookup deferred after +exclude_unknown (default)
3485 DEFER lookup failure, if +defer_unknown was set
3489 verify_check_dnsbl(uschar
**listptr
)
3492 int defer_return
= FAIL
;
3493 uschar
*list
= *listptr
;
3496 uschar buffer
[1024];
3497 uschar revadd
[128]; /* Long enough for IPv6 address */
3499 /* Indicate that the inverted IP address is not yet set up */
3503 /* In case this is the first time the DNS resolver is being used. */
3505 dns_init(FALSE
, FALSE
);
3507 /* Loop through all the domains supplied, until something matches */
3509 while ((domain
= string_nextinlist(&list
, &sep
, buffer
, sizeof(buffer
))) != NULL
)
3512 BOOL bitmask
= FALSE
;
3519 HDEBUG(D_dnsbl
) debug_printf("DNS list check: %s\n", domain
);
3521 /* Deal with special values that change the behaviour on defer */
3523 if (domain
[0] == '+')
3525 if (strcmpic(domain
, US
"+include_unknown") == 0) defer_return
= OK
;
3526 else if (strcmpic(domain
, US
"+exclude_unknown") == 0) defer_return
= FAIL
;
3527 else if (strcmpic(domain
, US
"+defer_unknown") == 0) defer_return
= DEFER
;
3529 log_write(0, LOG_MAIN
|LOG_PANIC
, "unknown item in dnslist (ignored): %s",
3534 /* See if there's explicit data to be looked up */
3536 key
= Ustrchr(domain
, '/');
3537 if (key
!= NULL
) *key
++ = 0;
3539 /* See if there's a list of addresses supplied after the domain name. This is
3540 introduced by an = or a & character; if preceded by = we require all matches
3541 and if preceded by ! we invert the result. */
3543 iplist
= Ustrchr(domain
, '=');
3547 iplist
= Ustrchr(domain
, '&');
3550 if (iplist
!= NULL
) /* Found either = or & */
3552 if (iplist
> domain
&& iplist
[-1] == '!') /* Handle preceding ! */
3554 match_type
|= MT_NOT
;
3558 *iplist
++ = 0; /* Terminate domain, move on */
3560 /* If we found = (bitmask == FALSE), check for == or =& */
3562 if (!bitmask
&& (*iplist
== '=' || *iplist
== '&'))
3564 bitmask
= *iplist
++ == '&';
3565 match_type
|= MT_ALL
;
3569 /* If there is a comma in the domain, it indicates that a second domain for
3570 looking up TXT records is provided, before the main domain. Otherwise we must
3571 set domain_txt == domain. */
3573 domain_txt
= domain
;
3574 comma
= Ustrchr(domain
, ',');
3581 /* Check that what we have left is a sensible domain name. There is no reason
3582 why these domains should in fact use the same syntax as hosts and email
3583 domains, but in practice they seem to. However, there is little point in
3584 actually causing an error here, because that would no doubt hold up incoming
3585 mail. Instead, I'll just log it. */
3587 for (s
= domain
; *s
!= 0; s
++)
3589 if (!isalnum(*s
) && *s
!= '-' && *s
!= '.' && *s
!= '_')
3591 log_write(0, LOG_MAIN
, "dnslists domain \"%s\" contains "
3592 "strange characters - is this right?", domain
);
3597 /* Check the alternate domain if present */
3599 if (domain_txt
!= domain
) for (s
= domain_txt
; *s
!= 0; s
++)
3601 if (!isalnum(*s
) && *s
!= '-' && *s
!= '.' && *s
!= '_')
3603 log_write(0, LOG_MAIN
, "dnslists domain \"%s\" contains "
3604 "strange characters - is this right?", domain_txt
);
3609 /* If there is no key string, construct the query by adding the domain name
3610 onto the inverted host address, and perform a single DNS lookup. */
3614 if (sender_host_address
== NULL
) return FAIL
; /* can never match */
3615 if (revadd
[0] == 0) invert_address(revadd
, sender_host_address
);
3616 rc
= one_check_dnsbl(domain
, domain_txt
, sender_host_address
, revadd
,
3617 iplist
, bitmask
, match_type
, defer_return
);
3620 dnslist_domain
= string_copy(domain_txt
);
3621 dnslist_matched
= string_copy(sender_host_address
);
3622 HDEBUG(D_dnsbl
) debug_printf("=> that means %s is listed at %s\n",
3623 sender_host_address
, dnslist_domain
);
3625 if (rc
!= FAIL
) return rc
; /* OK or DEFER */
3628 /* If there is a key string, it can be a list of domains or IP addresses to
3629 be concatenated with the main domain. */
3636 uschar keybuffer
[256];
3637 uschar keyrevadd
[128];
3639 while ((keydomain
= string_nextinlist(&key
, &keysep
, keybuffer
,
3640 sizeof(keybuffer
))) != NULL
)
3642 uschar
*prepend
= keydomain
;
3644 if (string_is_ip_address(keydomain
, NULL
) != 0)
3646 invert_address(keyrevadd
, keydomain
);
3647 prepend
= keyrevadd
;
3650 rc
= one_check_dnsbl(domain
, domain_txt
, keydomain
, prepend
, iplist
,
3651 bitmask
, match_type
, defer_return
);
3655 dnslist_domain
= string_copy(domain_txt
);
3656 dnslist_matched
= string_copy(keydomain
);
3657 HDEBUG(D_dnsbl
) debug_printf("=> that means %s is listed at %s\n",
3658 keydomain
, dnslist_domain
);
3662 /* If the lookup deferred, remember this fact. We keep trying the rest
3663 of the list to see if we get a useful result, and if we don't, we return
3664 DEFER at the end. */
3666 if (rc
== DEFER
) defer
= TRUE
;
3667 } /* continue with next keystring domain/address */
3669 if (defer
) return DEFER
;
3671 } /* continue with next dnsdb outer domain */
3676 /* End of verify.c */