1 /* $Cambridge: exim/src/src/verify.c,v 1.55 2010/06/05 23:50:18 pdp Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2009 */
8 /* See the file NOTICE for conditions of use and distribution. */
10 /* Functions concerned with verifying things. The original code for callout
11 caching was contributed by Kevin Fleming (but I hacked it around a bit). */
17 /* Structure for caching DNSBL lookups */
19 typedef struct dnsbl_cache_block {
27 /* Anchor for DNSBL cache */
29 static tree_node *dnsbl_cache = NULL;
32 /* Bits for match_type in one_check_dnsbl() */
39 /*************************************************
40 * Retrieve a callout cache record *
41 *************************************************/
43 /* If a record exists, check whether it has expired.
46 dbm_file an open hints file
48 type "address" or "domain"
49 positive_expire expire time for positive records
50 negative_expire expire time for negative records
52 Returns: the cache record if a non-expired one exists, else NULL
55 static dbdata_callout_cache *
56 get_callout_cache_record(open_db *dbm_file, uschar *key, uschar *type,
57 int positive_expire, int negative_expire)
62 dbdata_callout_cache *cache_record;
64 cache_record = dbfn_read_with_length(dbm_file, key, &length);
66 if (cache_record == NULL)
68 HDEBUG(D_verify) debug_printf("callout cache: no %s record found\n", type);
72 /* We treat a record as "negative" if its result field is not positive, or if
73 it is a domain record and the postmaster field is negative. */
75 negative = cache_record->result != ccache_accept ||
76 (type[0] == 'd' && cache_record->postmaster_result == ccache_reject);
77 expire = negative? negative_expire : positive_expire;
80 if (now - cache_record->time_stamp > expire)
82 HDEBUG(D_verify) debug_printf("callout cache: %s record expired\n", type);
86 /* If this is a non-reject domain record, check for the obsolete format version
87 that doesn't have the postmaster and random timestamps, by looking at the
88 length. If so, copy it to a new-style block, replicating the record's
89 timestamp. Then check the additional timestamps. (There's no point wasting
90 effort if connections are rejected.) */
92 if (type[0] == 'd' && cache_record->result != ccache_reject)
94 if (length == sizeof(dbdata_callout_cache_obs))
96 dbdata_callout_cache *new = store_get(sizeof(dbdata_callout_cache));
97 memcpy(new, cache_record, length);
98 new->postmaster_stamp = new->random_stamp = new->time_stamp;
102 if (now - cache_record->postmaster_stamp > expire)
103 cache_record->postmaster_result = ccache_unknown;
105 if (now - cache_record->random_stamp > expire)
106 cache_record->random_result = ccache_unknown;
109 HDEBUG(D_verify) debug_printf("callout cache: found %s record\n", type);
115 /*************************************************
116 * Do callout verification for an address *
117 *************************************************/
119 /* This function is called from verify_address() when the address has routed to
120 a host list, and a callout has been requested. Callouts are expensive; that is
121 why a cache is used to improve the efficiency.
124 addr the address that's been routed
125 host_list the list of hosts to try
126 tf the transport feedback block
128 ifstring "interface" option from transport, or NULL
129 portstring "port" option from transport, or NULL
130 protocolstring "protocol" option from transport, or NULL
131 callout the per-command callout timeout
132 callout_overall the overall callout timeout (if < 0 use 4*callout)
133 callout_connect the callout connection timeout (if < 0 use callout)
134 options the verification options - these bits are used:
135 vopt_is_recipient => this is a recipient address
136 vopt_callout_no_cache => don't use callout cache
137 vopt_callout_fullpm => if postmaster check, do full one
138 vopt_callout_random => do the "random" thing
139 vopt_callout_recipsender => use real sender for recipient
140 vopt_callout_recippmaster => use postmaster for recipient
141 se_mailfrom MAIL FROM address for sender verify; NULL => ""
142 pm_mailfrom if non-NULL, do the postmaster check with this sender
144 Returns: OK/FAIL/DEFER
148 do_callout(address_item *addr, host_item *host_list, transport_feedback *tf,
149 int callout, int callout_overall, int callout_connect, int options,
150 uschar *se_mailfrom, uschar *pm_mailfrom)
152 BOOL is_recipient = (options & vopt_is_recipient) != 0;
153 BOOL callout_no_cache = (options & vopt_callout_no_cache) != 0;
154 BOOL callout_random = (options & vopt_callout_random) != 0;
157 int old_domain_cache_result = ccache_accept;
160 uschar *from_address;
161 uschar *random_local_part = NULL;
162 uschar *save_deliver_domain = deliver_domain;
163 uschar **failure_ptr = is_recipient?
164 &recipient_verify_failure : &sender_verify_failure;
166 open_db *dbm_file = NULL;
167 dbdata_callout_cache new_domain_record;
168 dbdata_callout_cache_address new_address_record;
170 time_t callout_start_time;
172 new_domain_record.result = ccache_unknown;
173 new_domain_record.postmaster_result = ccache_unknown;
174 new_domain_record.random_result = ccache_unknown;
176 memset(&new_address_record, 0, sizeof(new_address_record));
178 /* For a recipient callout, the key used for the address cache record must
179 include the sender address if we are using the real sender in the callout,
180 because that may influence the result of the callout. */
182 address_key = addr->address;
187 if ((options & vopt_callout_recipsender) != 0)
189 address_key = string_sprintf("%s/<%s>", addr->address, sender_address);
190 from_address = sender_address;
192 else if ((options & vopt_callout_recippmaster) != 0)
194 address_key = string_sprintf("%s/<postmaster@%s>", addr->address,
195 qualify_domain_sender);
196 from_address = string_sprintf("postmaster@%s", qualify_domain_sender);
200 /* For a sender callout, we must adjust the key if the mailfrom address is not
205 from_address = (se_mailfrom == NULL)? US"" : se_mailfrom;
206 if (from_address[0] != 0)
207 address_key = string_sprintf("%s/<%s>", addr->address, from_address);
210 /* Open the callout cache database, it it exists, for reading only at this
211 stage, unless caching has been disabled. */
213 if (callout_no_cache)
215 HDEBUG(D_verify) debug_printf("callout cache: disabled by no_cache\n");
217 else if ((dbm_file = dbfn_open(US"callout", O_RDWR, &dbblock, FALSE)) == NULL)
219 HDEBUG(D_verify) debug_printf("callout cache: not available\n");
222 /* If a cache database is available see if we can avoid the need to do an
223 actual callout by making use of previously-obtained data. */
225 if (dbm_file != NULL)
227 dbdata_callout_cache_address *cache_address_record;
228 dbdata_callout_cache *cache_record = get_callout_cache_record(dbm_file,
229 addr->domain, US"domain",
230 callout_cache_domain_positive_expire,
231 callout_cache_domain_negative_expire);
233 /* If an unexpired cache record was found for this domain, see if the callout
234 process can be short-circuited. */
236 if (cache_record != NULL)
238 /* In most cases, if an early command (up to and including MAIL FROM:<>)
239 was rejected, there is no point carrying on. The callout fails. However, if
240 we are doing a recipient verification with use_sender or use_postmaster
241 set, a previous failure of MAIL FROM:<> doesn't count, because this time we
242 will be using a non-empty sender. We have to remember this situation so as
243 not to disturb the cached domain value if this whole verification succeeds
244 (we don't want it turning into "accept"). */
246 old_domain_cache_result = cache_record->result;
248 if (cache_record->result == ccache_reject ||
249 (*from_address == 0 && cache_record->result == ccache_reject_mfnull))
251 setflag(addr, af_verify_nsfail);
253 debug_printf("callout cache: domain gave initial rejection, or "
254 "does not accept HELO or MAIL FROM:<>\n");
255 setflag(addr, af_verify_nsfail);
256 addr->user_message = US"(result of an earlier callout reused).";
258 *failure_ptr = US"mail";
262 /* If a previous check on a "random" local part was accepted, we assume
263 that the server does not do any checking on local parts. There is therefore
264 no point in doing the callout, because it will always be successful. If a
265 random check previously failed, arrange not to do it again, but preserve
266 the data in the new record. If a random check is required but hasn't been
267 done, skip the remaining cache processing. */
269 if (callout_random) switch(cache_record->random_result)
273 debug_printf("callout cache: domain accepts random addresses\n");
274 goto END_CALLOUT; /* Default yield is OK */
278 debug_printf("callout cache: domain rejects random addresses\n");
279 callout_random = FALSE;
280 new_domain_record.random_result = ccache_reject;
281 new_domain_record.random_stamp = cache_record->random_stamp;
286 debug_printf("callout cache: need to check random address handling "
287 "(not cached or cache expired)\n");
291 /* If a postmaster check is requested, but there was a previous failure,
292 there is again no point in carrying on. If a postmaster check is required,
293 but has not been done before, we are going to have to do a callout, so skip
294 remaining cache processing. */
296 if (pm_mailfrom != NULL)
298 if (cache_record->postmaster_result == ccache_reject)
300 setflag(addr, af_verify_pmfail);
302 debug_printf("callout cache: domain does not accept "
303 "RCPT TO:<postmaster@domain>\n");
305 *failure_ptr = US"postmaster";
306 setflag(addr, af_verify_pmfail);
307 addr->user_message = US"(result of earlier verification reused).";
310 if (cache_record->postmaster_result == ccache_unknown)
313 debug_printf("callout cache: need to check RCPT "
314 "TO:<postmaster@domain> (not cached or cache expired)\n");
318 /* If cache says OK, set pm_mailfrom NULL to prevent a redundant
319 postmaster check if the address itself has to be checked. Also ensure
320 that the value in the cache record is preserved (with its old timestamp).
323 HDEBUG(D_verify) debug_printf("callout cache: domain accepts RCPT "
324 "TO:<postmaster@domain>\n");
326 new_domain_record.postmaster_result = ccache_accept;
327 new_domain_record.postmaster_stamp = cache_record->postmaster_stamp;
331 /* We can't give a result based on information about the domain. See if there
332 is an unexpired cache record for this specific address (combined with the
333 sender address if we are doing a recipient callout with a non-empty sender).
336 cache_address_record = (dbdata_callout_cache_address *)
337 get_callout_cache_record(dbm_file,
338 address_key, US"address",
339 callout_cache_positive_expire,
340 callout_cache_negative_expire);
342 if (cache_address_record != NULL)
344 if (cache_address_record->result == ccache_accept)
347 debug_printf("callout cache: address record is positive\n");
352 debug_printf("callout cache: address record is negative\n");
353 addr->user_message = US"Previous (cached) callout verification failure";
354 *failure_ptr = US"recipient";
360 /* Close the cache database while we actually do the callout for real. */
363 dbfn_close(dbm_file);
367 /* The information wasn't available in the cache, so we have to do a real
368 callout and save the result in the cache for next time, unless no_cache is set,
369 or unless we have a previously cached negative random result. If we are to test
370 with a random local part, ensure that such a local part is available. If not,
371 log the fact, but carry on without randomming. */
373 if (callout_random && callout_random_local_part != NULL)
375 random_local_part = expand_string(callout_random_local_part);
376 if (random_local_part == NULL)
377 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand "
378 "callout_random_local_part: %s", expand_string_message);
381 /* Default the connect and overall callout timeouts if not set, and record the
382 time we are starting so that we can enforce it. */
384 if (callout_overall < 0) callout_overall = 4 * callout;
385 if (callout_connect < 0) callout_connect = callout;
386 callout_start_time = time(NULL);
388 /* Before doing a real callout, if this is an SMTP connection, flush the SMTP
389 output because a callout might take some time. When PIPELINING is active and
390 there are many recipients, the total time for doing lots of callouts can add up
391 and cause the client to time out. So in this case we forgo the PIPELINING
394 if (smtp_out != NULL && !disable_callout_flush) mac_smtp_fflush();
396 /* Now make connections to the hosts and do real callouts. The list of hosts
397 is passed in as an argument. */
399 for (host = host_list; host != NULL && !done; host = host->next)
401 smtp_inblock inblock;
402 smtp_outblock outblock;
405 BOOL send_quit = TRUE;
406 uschar *active_hostname = smtp_active_hostname;
407 uschar *helo = US"HELO";
408 uschar *interface = NULL; /* Outgoing interface to use; NULL => any */
409 uschar inbuffer[4096];
410 uschar outbuffer[1024];
411 uschar responsebuffer[4096];
413 clearflag(addr, af_verify_pmfail); /* postmaster callout flag */
414 clearflag(addr, af_verify_nsfail); /* null sender callout flag */
416 /* Skip this host if we don't have an IP address for it. */
418 if (host->address == NULL)
420 DEBUG(D_verify) debug_printf("no IP address for host name %s: skipping\n",
425 /* Check the overall callout timeout */
427 if (time(NULL) - callout_start_time >= callout_overall)
429 HDEBUG(D_verify) debug_printf("overall timeout for callout exceeded\n");
433 /* Set IPv4 or IPv6 */
435 host_af = (Ustrchr(host->address, ':') == NULL)? AF_INET:AF_INET6;
437 /* Expand and interpret the interface and port strings. The latter will not
438 be used if there is a host-specific port (e.g. from a manualroute router).
439 This has to be delayed till now, because they may expand differently for
440 different hosts. If there's a failure, log it, but carry on with the
443 deliver_host = host->name;
444 deliver_host_address = host->address;
445 deliver_domain = addr->domain;
447 if (!smtp_get_interface(tf->interface, host_af, addr, NULL, &interface,
449 !smtp_get_port(tf->port, addr, &port, US"callout"))
450 log_write(0, LOG_MAIN|LOG_PANIC, "<%s>: %s", addr->address,
453 /* Set HELO string according to the protocol */
455 if (Ustrcmp(tf->protocol, "lmtp") == 0) helo = US"LHLO";
457 HDEBUG(D_verify) debug_printf("interface=%s port=%d\n", interface, port);
459 /* Set up the buffer for reading SMTP response packets. */
461 inblock.buffer = inbuffer;
462 inblock.buffersize = sizeof(inbuffer);
463 inblock.ptr = inbuffer;
464 inblock.ptrend = inbuffer;
466 /* Set up the buffer for holding SMTP commands while pipelining */
468 outblock.buffer = outbuffer;
469 outblock.buffersize = sizeof(outbuffer);
470 outblock.ptr = outbuffer;
471 outblock.cmd_count = 0;
472 outblock.authenticating = FALSE;
474 /* Connect to the host; on failure, just loop for the next one, but we
475 set the error for the last one. Use the callout_connect timeout. */
477 inblock.sock = outblock.sock =
478 smtp_connect(host, host_af, port, interface, callout_connect, TRUE);
479 if (inblock.sock < 0)
481 addr->message = string_sprintf("could not connect to %s [%s]: %s",
482 host->name, host->address, strerror(errno));
483 deliver_host = deliver_host_address = NULL;
484 deliver_domain = save_deliver_domain;
488 /* Expand the helo_data string to find the host name to use. */
490 if (tf->helo_data != NULL)
492 uschar *s = expand_string(tf->helo_data);
494 log_write(0, LOG_MAIN|LOG_PANIC, "<%s>: failed to expand transport's "
495 "helo_data value for callout: %s", addr->address,
496 expand_string_message);
497 else active_hostname = s;
500 deliver_host = deliver_host_address = NULL;
501 deliver_domain = save_deliver_domain;
503 /* Wait for initial response, and send HELO. The smtp_write_command()
504 function leaves its command in big_buffer. This is used in error responses.
505 Initialize it in case the connection is rejected. */
507 Ustrcpy(big_buffer, "initial connection");
510 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
512 smtp_write_command(&outblock, FALSE, "%s %s\r\n", helo,
513 active_hostname) >= 0 &&
514 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
517 /* Failure to accept HELO is cached; this blocks the whole domain for all
518 senders. I/O errors and defer responses are not cached. */
522 *failure_ptr = US"mail"; /* At or before MAIL */
523 if (errno == 0 && responsebuffer[0] == '5')
525 setflag(addr, af_verify_nsfail);
526 new_domain_record.result = ccache_reject;
530 /* Send the MAIL command */
533 smtp_write_command(&outblock, FALSE, "MAIL FROM:<%s>\r\n",
534 from_address) >= 0 &&
535 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
538 /* If the host does not accept MAIL FROM:<>, arrange to cache this
539 information, but again, don't record anything for an I/O error or a defer. Do
540 not cache rejections of MAIL when a non-empty sender has been used, because
541 that blocks the whole domain for all senders. */
545 *failure_ptr = US"mail"; /* At or before MAIL */
546 if (errno == 0 && responsebuffer[0] == '5')
548 setflag(addr, af_verify_nsfail);
549 if (from_address[0] == 0)
550 new_domain_record.result = ccache_reject_mfnull;
554 /* Otherwise, proceed to check a "random" address (if required), then the
555 given address, and the postmaster address (if required). Between each check,
556 issue RSET, because some servers accept only one recipient after MAIL
559 Before doing this, set the result in the domain cache record to "accept",
560 unless its previous value was ccache_reject_mfnull. In that case, the domain
561 rejects MAIL FROM:<> and we want to continue to remember that. When that is
562 the case, we have got here only in the case of a recipient verification with
563 a non-null sender. */
567 new_domain_record.result =
568 (old_domain_cache_result == ccache_reject_mfnull)?
569 ccache_reject_mfnull: ccache_accept;
571 /* Do the random local part check first */
573 if (random_local_part != NULL)
575 uschar randombuffer[1024];
577 smtp_write_command(&outblock, FALSE,
578 "RCPT TO:<%.1000s@%.1000s>\r\n", random_local_part,
579 addr->domain) >= 0 &&
580 smtp_read_response(&inblock, randombuffer,
581 sizeof(randombuffer), '2', callout);
583 /* Remember when we last did a random test */
585 new_domain_record.random_stamp = time(NULL);
587 /* If accepted, we aren't going to do any further tests below. */
591 new_domain_record.random_result = ccache_accept;
594 /* Otherwise, cache a real negative response, and get back to the right
595 state to send RCPT. Unless there's some problem such as a dropped
596 connection, we expect to succeed, because the commands succeeded above. */
600 if (randombuffer[0] == '5')
601 new_domain_record.random_result = ccache_reject;
604 smtp_write_command(&outblock, FALSE, "RSET\r\n") >= 0 &&
605 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
608 smtp_write_command(&outblock, FALSE, "MAIL FROM:<%s>\r\n",
609 from_address) >= 0 &&
610 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
613 else done = FALSE; /* Some timeout/connection problem */
616 /* If the host is accepting all local parts, as determined by the "random"
617 check, we don't need to waste time doing any further checking. */
619 if (new_domain_record.random_result != ccache_accept && done)
621 /* Get the rcpt_include_affixes flag from the transport if there is one,
622 but assume FALSE if there is not. */
625 smtp_write_command(&outblock, FALSE, "RCPT TO:<%.1000s>\r\n",
626 transport_rcpt_address(addr,
627 (addr->transport == NULL)? FALSE :
628 addr->transport->rcpt_include_affixes)) >= 0 &&
629 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
633 new_address_record.result = ccache_accept;
634 else if (errno == 0 && responsebuffer[0] == '5')
636 *failure_ptr = US"recipient";
637 new_address_record.result = ccache_reject;
640 /* Do postmaster check if requested; if a full check is required, we
641 check for RCPT TO:<postmaster> (no domain) in accordance with RFC 821. */
643 if (done && pm_mailfrom != NULL)
646 smtp_write_command(&outblock, FALSE, "RSET\r\n") >= 0 &&
647 smtp_read_response(&inblock, responsebuffer,
648 sizeof(responsebuffer), '2', callout) &&
650 smtp_write_command(&outblock, FALSE,
651 "MAIL FROM:<%s>\r\n", pm_mailfrom) >= 0 &&
652 smtp_read_response(&inblock, responsebuffer,
653 sizeof(responsebuffer), '2', callout) &&
655 /* First try using the current domain */
658 smtp_write_command(&outblock, FALSE,
659 "RCPT TO:<postmaster@%.1000s>\r\n", addr->domain) >= 0 &&
660 smtp_read_response(&inblock, responsebuffer,
661 sizeof(responsebuffer), '2', callout)
666 /* If that doesn't work, and a full check is requested,
667 try without the domain. */
670 (options & vopt_callout_fullpm) != 0 &&
671 smtp_write_command(&outblock, FALSE,
672 "RCPT TO:<postmaster>\r\n") >= 0 &&
673 smtp_read_response(&inblock, responsebuffer,
674 sizeof(responsebuffer), '2', callout)
677 /* Sort out the cache record */
679 new_domain_record.postmaster_stamp = time(NULL);
682 new_domain_record.postmaster_result = ccache_accept;
683 else if (errno == 0 && responsebuffer[0] == '5')
685 *failure_ptr = US"postmaster";
686 setflag(addr, af_verify_pmfail);
687 new_domain_record.postmaster_result = ccache_reject;
690 } /* Random not accepted */
691 } /* MAIL FROM: accepted */
693 /* For any failure of the main check, other than a negative response, we just
694 close the connection and carry on. We can identify a negative response by the
695 fact that errno is zero. For I/O errors it will be non-zero
697 Set up different error texts for logging and for sending back to the caller
698 as an SMTP response. Log in all cases, using a one-line format. For sender
699 callouts, give a full response to the caller, but for recipient callouts,
700 don't give the IP address because this may be an internal host whose identity
701 is not to be widely broadcast. */
705 if (errno == ETIMEDOUT)
707 HDEBUG(D_verify) debug_printf("SMTP timeout\n");
712 if (*responsebuffer == 0) Ustrcpy(responsebuffer, US"connection dropped");
715 string_sprintf("response to \"%s\" from %s [%s] was: %s",
716 big_buffer, host->name, host->address,
717 string_printing(responsebuffer));
719 addr->user_message = is_recipient?
720 string_sprintf("Callout verification failed:\n%s", responsebuffer)
722 string_sprintf("Called: %s\nSent: %s\nResponse: %s",
723 host->address, big_buffer, responsebuffer);
725 /* Hard rejection ends the process */
727 if (responsebuffer[0] == '5') /* Address rejected */
735 /* End the SMTP conversation and close the connection. */
737 if (send_quit) (void)smtp_write_command(&outblock, FALSE, "QUIT\r\n");
738 (void)close(inblock.sock);
739 } /* Loop through all hosts, while !done */
741 /* If we get here with done == TRUE, a successful callout happened, and yield
742 will be set OK or FAIL according to the response to the RCPT command.
743 Otherwise, we looped through the hosts but couldn't complete the business.
744 However, there may be domain-specific information to cache in both cases.
746 The value of the result field in the new_domain record is ccache_unknown if
747 there was an error before or with MAIL FROM:, and errno was not zero,
748 implying some kind of I/O error. We don't want to write the cache in that case.
749 Otherwise the value is ccache_accept, ccache_reject, or ccache_reject_mfnull. */
751 if (!callout_no_cache && new_domain_record.result != ccache_unknown)
753 if ((dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE))
756 HDEBUG(D_verify) debug_printf("callout cache: not available\n");
760 (void)dbfn_write(dbm_file, addr->domain, &new_domain_record,
761 (int)sizeof(dbdata_callout_cache));
762 HDEBUG(D_verify) debug_printf("wrote callout cache domain record:\n"
763 " result=%d postmaster=%d random=%d\n",
764 new_domain_record.result,
765 new_domain_record.postmaster_result,
766 new_domain_record.random_result);
770 /* If a definite result was obtained for the callout, cache it unless caching
775 if (!callout_no_cache && new_address_record.result != ccache_unknown)
777 if (dbm_file == NULL)
778 dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE);
779 if (dbm_file == NULL)
781 HDEBUG(D_verify) debug_printf("no callout cache available\n");
785 (void)dbfn_write(dbm_file, address_key, &new_address_record,
786 (int)sizeof(dbdata_callout_cache_address));
787 HDEBUG(D_verify) debug_printf("wrote %s callout cache address record\n",
788 (new_address_record.result == ccache_accept)? "positive" : "negative");
793 /* Failure to connect to any host, or any response other than 2xx or 5xx is a
794 temporary error. If there was only one host, and a response was received, leave
795 it alone if supplying details. Otherwise, give a generic response. */
799 uschar *dullmsg = string_sprintf("Could not complete %s verify callout",
800 is_recipient? "recipient" : "sender");
803 if (host_list->next != NULL || addr->message == NULL) addr->message = dullmsg;
805 addr->user_message = (!smtp_return_error_details)? dullmsg :
806 string_sprintf("%s for <%s>.\n"
807 "The mail server(s) for the domain may be temporarily unreachable, or\n"
808 "they may be permanently unreachable from this server. In the latter case,\n%s",
809 dullmsg, addr->address,
811 "the address will never be accepted."
813 "you need to change the address or create an MX record for its domain\n"
814 "if it is supposed to be generally accessible from the Internet.\n"
815 "Talk to your mail administrator for details.");
817 /* Force a specific error code */
819 addr->basic_errno = ERRNO_CALLOUTDEFER;
822 /* Come here from within the cache-reading code on fast-track exit. */
825 if (dbm_file != NULL) dbfn_close(dbm_file);
831 /*************************************************
832 * Copy error to toplevel address *
833 *************************************************/
835 /* This function is used when a verify fails or defers, to ensure that the
836 failure or defer information is in the original toplevel address. This applies
837 when an address is redirected to a single new address, and the failure or
838 deferral happens to the child address.
841 vaddr the verify address item
842 addr the final address item
845 Returns: the value of YIELD
849 copy_error(address_item *vaddr, address_item *addr, int yield)
853 vaddr->message = addr->message;
854 vaddr->user_message = addr->user_message;
855 vaddr->basic_errno = addr->basic_errno;
856 vaddr->more_errno = addr->more_errno;
857 vaddr->p.address_data = addr->p.address_data;
858 copyflag(vaddr, addr, af_pass_message);
866 /**************************************************
867 * printf that automatically handles TLS if needed *
868 ***************************************************/
870 /* This function is used by verify_address() as a substitute for all fprintf()
871 calls; a direct fprintf() will not produce output in a TLS SMTP session, such
872 as a response to an EXPN command. smtp_in.c makes smtp_printf available but
873 that assumes that we always use the smtp_out FILE* when not using TLS or the
874 ssl buffer when we are. Instead we take a FILE* parameter and check to see if
875 that is smtp_out; if so, smtp_printf() with TLS support, otherwise regular
879 f the candidate FILE* to write to
881 ... optional arguments
887 static void PRINTF_FUNCTION(2,3)
888 respond_printf(FILE *f, const char *format, ...)
892 va_start(ap, format);
893 if (smtp_out && (f == smtp_out))
894 smtp_vprintf(format, ap);
896 vfprintf(f, format, ap);
902 /*************************************************
903 * Verify an email address *
904 *************************************************/
906 /* This function is used both for verification (-bv and at other times) and
907 address testing (-bt), which is indicated by address_test_mode being set.
910 vaddr contains the address to verify; the next field in this block
912 f if not NULL, write the result to this file
913 options various option bits:
914 vopt_fake_sender => this sender verify is not for the real
915 sender (it was verify=sender=xxxx or an address from a
916 header line) - rewriting must not change sender_address
917 vopt_is_recipient => this is a recipient address, otherwise
918 it's a sender address - this affects qualification and
919 rewriting and messages from callouts
920 vopt_qualify => qualify an unqualified address; else error
921 vopt_expn => called from SMTP EXPN command
922 vopt_success_on_redirect => when a new address is generated
923 the verification instantly succeeds
925 These ones are used by do_callout() -- the options variable
928 vopt_callout_fullpm => if postmaster check, do full one
929 vopt_callout_no_cache => don't use callout cache
930 vopt_callout_random => do the "random" thing
931 vopt_callout_recipsender => use real sender for recipient
932 vopt_callout_recippmaster => use postmaster for recipient
934 callout if > 0, specifies that callout is required, and gives timeout
935 for individual commands
936 callout_overall if > 0, gives overall timeout for the callout function;
937 if < 0, a default is used (see do_callout())
938 callout_connect the connection timeout for callouts
939 se_mailfrom when callout is requested to verify a sender, use this
940 in MAIL FROM; NULL => ""
941 pm_mailfrom when callout is requested, if non-NULL, do the postmaster
942 thing and use this as the sender address (may be "")
944 routed if not NULL, set TRUE if routing succeeded, so we can
945 distinguish between routing failed and callout failed
947 Returns: OK address verified
948 FAIL address failed to verify
949 DEFER can't tell at present
953 verify_address(address_item *vaddr, FILE *f, int options, int callout,
954 int callout_overall, int callout_connect, uschar *se_mailfrom,
955 uschar *pm_mailfrom, BOOL *routed)
958 BOOL full_info = (f == NULL)? FALSE : (debug_selector != 0);
959 BOOL is_recipient = (options & vopt_is_recipient) != 0;
960 BOOL expn = (options & vopt_expn) != 0;
961 BOOL success_on_redirect = (options & vopt_success_on_redirect) != 0;
964 int verify_type = expn? v_expn :
965 address_test_mode? v_none :
966 is_recipient? v_recipient : v_sender;
967 address_item *addr_list;
968 address_item *addr_new = NULL;
969 address_item *addr_remote = NULL;
970 address_item *addr_local = NULL;
971 address_item *addr_succeed = NULL;
972 uschar **failure_ptr = is_recipient?
973 &recipient_verify_failure : &sender_verify_failure;
974 uschar *ko_prefix, *cr;
975 uschar *address = vaddr->address;
977 uschar null_sender[] = { 0 }; /* Ensure writeable memory */
979 /* Clear, just in case */
983 /* Set up a prefix and suffix for error message which allow us to use the same
984 output statements both in EXPN mode (where an SMTP response is needed) and when
985 debugging with an output file. */
989 ko_prefix = US"553 ";
992 else ko_prefix = cr = US"";
994 /* Add qualify domain if permitted; otherwise an unqualified address fails. */
996 if (parse_find_at(address) == NULL)
998 if ((options & vopt_qualify) == 0)
1001 respond_printf(f, "%sA domain is required for \"%s\"%s\n",
1002 ko_prefix, address, cr);
1003 *failure_ptr = US"qualify";
1006 address = rewrite_address_qualify(address, is_recipient);
1011 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
1012 debug_printf("%s %s\n", address_test_mode? "Testing" : "Verifying", address);
1015 /* Rewrite and report on it. Clear the domain and local part caches - these
1016 may have been set by domains and local part tests during an ACL. */
1018 if (global_rewrite_rules != NULL)
1020 uschar *old = address;
1021 address = rewrite_address(address, is_recipient, FALSE,
1022 global_rewrite_rules, rewrite_existflags);
1025 for (i = 0; i < (MAX_NAMED_LIST * 2)/32; i++) vaddr->localpart_cache[i] = 0;
1026 for (i = 0; i < (MAX_NAMED_LIST * 2)/32; i++) vaddr->domain_cache[i] = 0;
1027 if (f != NULL && !expn) fprintf(f, "Address rewritten as: %s\n", address);
1031 /* If this is the real sender address, we must update sender_address at
1032 this point, because it may be referred to in the routers. */
1034 if ((options & (vopt_fake_sender|vopt_is_recipient)) == 0)
1035 sender_address = address;
1037 /* If the address was rewritten to <> no verification can be done, and we have
1038 to return OK. This rewriting is permitted only for sender addresses; for other
1039 addresses, such rewriting fails. */
1041 if (address[0] == 0) return OK;
1043 /* Save a copy of the sender address for re-instating if we change it to <>
1044 while verifying a sender address (a nice bit of self-reference there). */
1046 save_sender = sender_address;
1048 /* Update the address structure with the possibly qualified and rewritten
1049 address. Set it up as the starting address on the chain of new addresses. */
1051 vaddr->address = address;
1054 /* We need a loop, because an address can generate new addresses. We must also
1055 cope with generated pipes and files at the top level. (See also the code and
1056 comment in deliver.c.) However, it is usually the case that the router for
1057 user's .forward files has its verify flag turned off.
1059 If an address generates more than one child, the loop is used only when
1060 full_info is set, and this can only be set locally. Remote enquiries just get
1061 information about the top level address, not anything that it generated. */
1063 while (addr_new != NULL)
1066 address_item *addr = addr_new;
1068 addr_new = addr->next;
1073 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
1074 debug_printf("Considering %s\n", addr->address);
1077 /* Handle generated pipe, file or reply addresses. We don't get these
1078 when handling EXPN, as it does only one level of expansion. */
1080 if (testflag(addr, af_pfr))
1087 if (addr->address[0] == '>')
1089 allow = testflag(addr, af_allow_reply);
1090 fprintf(f, "%s -> mail %s", addr->parent->address, addr->address + 1);
1094 allow = (addr->address[0] == '|')?
1095 testflag(addr, af_allow_pipe) : testflag(addr, af_allow_file);
1096 fprintf(f, "%s -> %s", addr->parent->address, addr->address);
1099 if (addr->basic_errno == ERRNO_BADTRANSPORT)
1100 fprintf(f, "\n*** Error in setting up pipe, file, or autoreply:\n"
1101 "%s\n", addr->message);
1103 fprintf(f, "\n transport = %s\n", addr->transport->name);
1105 fprintf(f, " *** forbidden ***\n");
1110 /* Just in case some router parameter refers to it. */
1112 return_path = (addr->p.errors_address != NULL)?
1113 addr->p.errors_address : sender_address;
1115 /* Split the address into domain and local part, handling the %-hack if
1116 necessary, and then route it. While routing a sender address, set
1117 $sender_address to <> because that is what it will be if we were trying to
1118 send a bounce to the sender. */
1120 if (routed != NULL) *routed = FALSE;
1121 if ((rc = deliver_split_address(addr)) == OK)
1123 if (!is_recipient) sender_address = null_sender;
1124 rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
1125 &addr_succeed, verify_type);
1126 sender_address = save_sender; /* Put back the real sender */
1129 /* If routing an address succeeded, set the flag that remembers, for use when
1130 an ACL cached a sender verify (in case a callout fails). Then if routing set
1131 up a list of hosts or the transport has a host list, and the callout option
1132 is set, and we aren't in a host checking run, do the callout verification,
1133 and set another flag that notes that a callout happened. */
1137 if (routed != NULL) *routed = TRUE;
1140 host_item *host_list = addr->host_list;
1142 /* Make up some data for use in the case where there is no remote
1145 transport_feedback tf = {
1146 NULL, /* interface (=> any) */
1147 US"smtp", /* port */
1148 US"smtp", /* protocol */
1150 US"$smtp_active_hostname", /* helo_data */
1151 FALSE, /* hosts_override */
1152 FALSE, /* hosts_randomize */
1153 FALSE, /* gethostbyname */
1154 TRUE, /* qualify_single */
1155 FALSE /* search_parents */
1158 /* If verification yielded a remote transport, we want to use that
1159 transport's options, so as to mimic what would happen if we were really
1160 sending a message to this address. */
1162 if (addr->transport != NULL && !addr->transport->info->local)
1164 (void)(addr->transport->setup)(addr->transport, addr, &tf, 0, 0, NULL);
1166 /* If the transport has hosts and the router does not, or if the
1167 transport is configured to override the router's hosts, we must build a
1168 host list of the transport's hosts, and find the IP addresses */
1170 if (tf.hosts != NULL && (host_list == NULL || tf.hosts_override))
1173 uschar *save_deliver_domain = deliver_domain;
1174 uschar *save_deliver_localpart = deliver_localpart;
1176 host_list = NULL; /* Ignore the router's hosts */
1178 deliver_domain = addr->domain;
1179 deliver_localpart = addr->local_part;
1180 s = expand_string(tf.hosts);
1181 deliver_domain = save_deliver_domain;
1182 deliver_localpart = save_deliver_localpart;
1186 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand list of hosts "
1187 "\"%s\" in %s transport for callout: %s", tf.hosts,
1188 addr->transport->name, expand_string_message);
1193 uschar *canonical_name;
1194 host_item *host, *nexthost;
1195 host_build_hostlist(&host_list, s, tf.hosts_randomize);
1197 /* Just ignore failures to find a host address. If we don't manage
1198 to find any addresses, the callout will defer. Note that more than
1199 one address may be found for a single host, which will result in
1200 additional host items being inserted into the chain. Hence we must
1201 save the next host first. */
1203 flags = HOST_FIND_BY_A;
1204 if (tf.qualify_single) flags |= HOST_FIND_QUALIFY_SINGLE;
1205 if (tf.search_parents) flags |= HOST_FIND_SEARCH_PARENTS;
1207 for (host = host_list; host != NULL; host = nexthost)
1209 nexthost = host->next;
1210 if (tf.gethostbyname ||
1211 string_is_ip_address(host->name, NULL) != 0)
1212 (void)host_find_byname(host, NULL, flags, &canonical_name, TRUE);
1214 (void)host_find_bydns(host, NULL, flags, NULL, NULL, NULL,
1215 &canonical_name, NULL);
1221 /* Can only do a callout if we have at least one host! If the callout
1222 fails, it will have set ${sender,recipient}_verify_failure. */
1224 if (host_list != NULL)
1226 HDEBUG(D_verify) debug_printf("Attempting full verification using callout\n");
1227 if (host_checking && !host_checking_callout)
1230 debug_printf("... callout omitted by default when host testing\n"
1231 "(Use -bhc if you want the callouts to happen.)\n");
1235 rc = do_callout(addr, host_list, &tf, callout, callout_overall,
1236 callout_connect, options, se_mailfrom, pm_mailfrom);
1241 HDEBUG(D_verify) debug_printf("Cannot do callout: neither router nor "
1242 "transport provided a host list\n");
1247 /* Otherwise, any failure is a routing failure */
1249 else *failure_ptr = US"route";
1251 /* A router may return REROUTED if it has set up a child address as a result
1252 of a change of domain name (typically from widening). In this case we always
1253 want to continue to verify the new child. */
1255 if (rc == REROUTED) continue;
1257 /* Handle hard failures */
1264 address_item *p = addr->parent;
1266 respond_printf(f, "%s%s %s", ko_prefix,
1267 full_info? addr->address : address,
1268 address_test_mode? "is undeliverable" : "failed to verify");
1269 if (!expn && admin_user)
1271 if (addr->basic_errno > 0)
1272 respond_printf(f, ": %s", strerror(addr->basic_errno));
1273 if (addr->message != NULL)
1274 respond_printf(f, ": %s", addr->message);
1277 /* Show parents iff doing full info */
1279 if (full_info) while (p != NULL)
1281 respond_printf(f, "%s\n <-- %s", cr, p->address);
1284 respond_printf(f, "%s\n", cr);
1287 if (!full_info) return copy_error(vaddr, addr, FAIL);
1293 else if (rc == DEFER)
1298 address_item *p = addr->parent;
1299 respond_printf(f, "%s%s cannot be resolved at this time", ko_prefix,
1300 full_info? addr->address : address);
1301 if (!expn && admin_user)
1303 if (addr->basic_errno > 0)
1304 respond_printf(f, ": %s", strerror(addr->basic_errno));
1305 if (addr->message != NULL)
1306 respond_printf(f, ": %s", addr->message);
1307 else if (addr->basic_errno <= 0)
1308 respond_printf(f, ": unknown error");
1311 /* Show parents iff doing full info */
1313 if (full_info) while (p != NULL)
1315 respond_printf(f, "%s\n <-- %s", cr, p->address);
1318 respond_printf(f, "%s\n", cr);
1320 if (!full_info) return copy_error(vaddr, addr, DEFER);
1321 else if (yield == OK) yield = DEFER;
1324 /* If we are handling EXPN, we do not want to continue to route beyond
1325 the top level (whose address is in "address"). */
1329 uschar *ok_prefix = US"250-";
1330 if (addr_new == NULL)
1332 if (addr_local == NULL && addr_remote == NULL)
1333 respond_printf(f, "250 mail to <%s> is discarded\r\n", address);
1335 respond_printf(f, "250 <%s>\r\n", address);
1337 else while (addr_new != NULL)
1339 address_item *addr2 = addr_new;
1340 addr_new = addr2->next;
1341 if (addr_new == NULL) ok_prefix = US"250 ";
1342 respond_printf(f, "%s<%s>\r\n", ok_prefix, addr2->address);
1347 /* Successful routing other than EXPN. */
1351 /* Handle successful routing when short info wanted. Otherwise continue for
1352 other (generated) addresses. Short info is the operational case. Full info
1353 can be requested only when debug_selector != 0 and a file is supplied.
1355 There is a conflict between the use of aliasing as an alternate email
1356 address, and as a sort of mailing list. If an alias turns the incoming
1357 address into just one address (e.g. J.Caesar->jc44) you may well want to
1358 carry on verifying the generated address to ensure it is valid when
1359 checking incoming mail. If aliasing generates multiple addresses, you
1360 probably don't want to do this. Exim therefore treats the generation of
1361 just a single new address as a special case, and continues on to verify the
1362 generated address. */
1364 if (!full_info && /* Stop if short info wanted AND */
1365 (((addr_new == NULL || /* No new address OR */
1366 addr_new->next != NULL || /* More than one new address OR */
1367 testflag(addr_new, af_pfr))) /* New address is pfr */
1369 (addr_new != NULL && /* At least one new address AND */
1370 success_on_redirect))) /* success_on_redirect is set */
1372 if (f != NULL) fprintf(f, "%s %s\n", address,
1373 address_test_mode? "is deliverable" : "verified");
1375 /* If we have carried on to verify a child address, we want the value
1376 of $address_data to be that of the child */
1378 vaddr->p.address_data = addr->p.address_data;
1382 } /* Loop for generated addresses */
1384 /* Display the full results of the successful routing, including any generated
1385 addresses. Control gets here only when full_info is set, which requires f not
1386 to be NULL, and this occurs only when a top-level verify is called with the
1387 debugging switch on.
1389 If there are no local and no remote addresses, and there were no pipes, files,
1390 or autoreplies, and there were no errors or deferments, the message is to be
1391 discarded, usually because of the use of :blackhole: in an alias file. */
1393 if (allok && addr_local == NULL && addr_remote == NULL)
1395 fprintf(f, "mail to %s is discarded\n", address);
1399 for (addr_list = addr_local, i = 0; i < 2; addr_list = addr_remote, i++)
1401 while (addr_list != NULL)
1403 address_item *addr = addr_list;
1404 address_item *p = addr->parent;
1405 addr_list = addr->next;
1407 fprintf(f, "%s", CS addr->address);
1408 #ifdef EXPERIMENTAL_SRS
1409 if(addr->p.srs_sender)
1410 fprintf(f, " [srs = %s]", addr->p.srs_sender);
1413 /* If the address is a duplicate, show something about it. */
1415 if (!testflag(addr, af_pfr))
1418 if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
1419 fprintf(f, " [duplicate, would not be delivered]");
1420 else tree_add_duplicate(addr->unique, addr);
1423 /* Now show its parents */
1427 fprintf(f, "\n <-- %s", p->address);
1432 /* Show router, and transport */
1434 fprintf(f, "router = %s, ", addr->router->name);
1435 fprintf(f, "transport = %s\n", (addr->transport == NULL)? US"unset" :
1436 addr->transport->name);
1438 /* Show any hosts that are set up by a router unless the transport
1439 is going to override them; fiddle a bit to get a nice format. */
1441 if (addr->host_list != NULL && addr->transport != NULL &&
1442 !addr->transport->overrides_hosts)
1447 for (h = addr->host_list; h != NULL; h = h->next)
1449 int len = Ustrlen(h->name);
1450 if (len > maxlen) maxlen = len;
1451 len = (h->address != NULL)? Ustrlen(h->address) : 7;
1452 if (len > maxaddlen) maxaddlen = len;
1454 for (h = addr->host_list; h != NULL; h = h->next)
1456 int len = Ustrlen(h->name);
1457 fprintf(f, " host %s ", h->name);
1458 while (len++ < maxlen) fprintf(f, " ");
1459 if (h->address != NULL)
1461 fprintf(f, "[%s] ", h->address);
1462 len = Ustrlen(h->address);
1464 else if (!addr->transport->info->local) /* Omit [unknown] for local */
1466 fprintf(f, "[unknown] ");
1470 while (len++ < maxaddlen) fprintf(f," ");
1471 if (h->mx >= 0) fprintf(f, "MX=%d", h->mx);
1472 if (h->port != PORT_NONE) fprintf(f, " port=%d", h->port);
1473 if (h->status == hstatus_unusable) fprintf(f, " ** unusable **");
1480 /* Will be DEFER or FAIL if any one address has, only for full_info (which is
1481 the -bv or -bt case). */
1489 /*************************************************
1490 * Check headers for syntax errors *
1491 *************************************************/
1493 /* This function checks those header lines that contain addresses, and verifies
1494 that all the addresses therein are syntactially correct.
1497 msgptr where to put an error message
1504 verify_check_headers(uschar **msgptr)
1510 for (h = header_list; h != NULL && yield == OK; h = h->next)
1512 if (h->type != htype_from &&
1513 h->type != htype_reply_to &&
1514 h->type != htype_sender &&
1515 h->type != htype_to &&
1516 h->type != htype_cc &&
1517 h->type != htype_bcc)
1520 colon = Ustrchr(h->text, ':');
1522 while (isspace(*s)) s++;
1524 /* Loop for multiple addresses in the header, enabling group syntax. Note
1525 that we have to reset this after the header has been scanned. */
1527 parse_allow_group = TRUE;
1531 uschar *ss = parse_find_address_end(s, FALSE);
1532 uschar *recipient, *errmess;
1533 int terminator = *ss;
1534 int start, end, domain;
1536 /* Temporarily terminate the string at this point, and extract the
1537 operative address within, allowing group syntax. */
1540 recipient = parse_extract_address(s,&errmess,&start,&end,&domain,FALSE);
1543 /* Permit an unqualified address only if the message is local, or if the
1544 sending host is configured to be permitted to send them. */
1546 if (recipient != NULL && domain == 0)
1548 if (h->type == htype_from || h->type == htype_sender)
1550 if (!allow_unqualified_sender) recipient = NULL;
1554 if (!allow_unqualified_recipient) recipient = NULL;
1556 if (recipient == NULL) errmess = US"unqualified address not permitted";
1559 /* It's an error if no address could be extracted, except for the special
1560 case of an empty address. */
1562 if (recipient == NULL && Ustrcmp(errmess, "empty address") != 0)
1564 uschar *verb = US"is";
1569 /* Arrange not to include any white space at the end in the
1570 error message or the header name. */
1572 while (t > s && isspace(t[-1])) t--;
1573 while (tt > h->text && isspace(tt[-1])) tt--;
1575 /* Add the address that failed to the error message, since in a
1576 header with very many addresses it is sometimes hard to spot
1577 which one is at fault. However, limit the amount of address to
1578 quote - cases have been seen where, for example, a missing double
1579 quote in a humungous To: header creates an "address" that is longer
1580 than string_sprintf can handle. */
1589 *msgptr = string_printing(
1590 string_sprintf("%s: failing address in \"%.*s:\" header %s: %.*s",
1591 errmess, tt - h->text, h->text, verb, len, s));
1594 break; /* Out of address loop */
1597 /* Advance to the next address */
1599 s = ss + (terminator? 1:0);
1600 while (isspace(*s)) s++;
1601 } /* Next address */
1603 parse_allow_group = FALSE;
1604 parse_found_group = FALSE;
1605 } /* Next header unless yield has been set FALSE */
1612 /*************************************************
1613 * Check for blind recipients *
1614 *************************************************/
1616 /* This function checks that every (envelope) recipient is mentioned in either
1617 the To: or Cc: header lines, thus detecting blind carbon copies.
1619 There are two ways of scanning that could be used: either scan the header lines
1620 and tick off the recipients, or scan the recipients and check the header lines.
1621 The original proposed patch did the former, but I have chosen to do the latter,
1622 because (a) it requires no memory and (b) will use fewer resources when there
1623 are many addresses in To: and/or Cc: and only one or two envelope recipients.
1626 Returns: OK if there are no blind recipients
1627 FAIL if there is at least one blind recipient
1631 verify_check_notblind(void)
1634 for (i = 0; i < recipients_count; i++)
1638 uschar *address = recipients_list[i].address;
1640 for (h = header_list; !found && h != NULL; h = h->next)
1644 if (h->type != htype_to && h->type != htype_cc) continue;
1646 colon = Ustrchr(h->text, ':');
1648 while (isspace(*s)) s++;
1650 /* Loop for multiple addresses in the header, enabling group syntax. Note
1651 that we have to reset this after the header has been scanned. */
1653 parse_allow_group = TRUE;
1657 uschar *ss = parse_find_address_end(s, FALSE);
1658 uschar *recipient,*errmess;
1659 int terminator = *ss;
1660 int start, end, domain;
1662 /* Temporarily terminate the string at this point, and extract the
1663 operative address within, allowing group syntax. */
1666 recipient = parse_extract_address(s,&errmess,&start,&end,&domain,FALSE);
1669 /* If we found a valid recipient that has a domain, compare it with the
1670 envelope recipient. Local parts are compared case-sensitively, domains
1671 case-insensitively. By comparing from the start with length "domain", we
1672 include the "@" at the end, which ensures that we are comparing the whole
1673 local part of each address. */
1675 if (recipient != NULL && domain != 0)
1677 found = Ustrncmp(recipient, address, domain) == 0 &&
1678 strcmpic(recipient + domain, address + domain) == 0;
1682 /* Advance to the next address */
1684 s = ss + (terminator? 1:0);
1685 while (isspace(*s)) s++;
1686 } /* Next address */
1688 parse_allow_group = FALSE;
1689 parse_found_group = FALSE;
1690 } /* Next header (if found is false) */
1692 if (!found) return FAIL;
1693 } /* Next recipient */
1700 /*************************************************
1701 * Find if verified sender *
1702 *************************************************/
1704 /* Usually, just a single address is verified as the sender of the message.
1705 However, Exim can be made to verify other addresses as well (often related in
1706 some way), and this is useful in some environments. There may therefore be a
1707 chain of such addresses that have previously been tested. This function finds
1708 whether a given address is on the chain.
1710 Arguments: the address to be verified
1711 Returns: pointer to an address item, or NULL
1715 verify_checked_sender(uschar *sender)
1718 for (addr = sender_verified_list; addr != NULL; addr = addr->next)
1719 if (Ustrcmp(sender, addr->address) == 0) break;
1727 /*************************************************
1728 * Get valid header address *
1729 *************************************************/
1731 /* Scan the originator headers of the message, looking for an address that
1732 verifies successfully. RFC 822 says:
1734 o The "Sender" field mailbox should be sent notices of
1735 any problems in transport or delivery of the original
1736 messages. If there is no "Sender" field, then the
1737 "From" field mailbox should be used.
1739 o If the "Reply-To" field exists, then the reply should
1740 go to the addresses indicated in that field and not to
1741 the address(es) indicated in the "From" field.
1743 So we check a Sender field if there is one, else a Reply_to field, else a From
1744 field. As some strange messages may have more than one of these fields,
1745 especially if they are resent- fields, check all of them if there is more than
1749 user_msgptr points to where to put a user error message
1750 log_msgptr points to where to put a log error message
1751 callout timeout for callout check (passed to verify_address())
1752 callout_overall overall callout timeout (ditto)
1753 callout_connect connect callout timeout (ditto)
1754 se_mailfrom mailfrom for verify; NULL => ""
1755 pm_mailfrom sender for pm callout check (passed to verify_address())
1756 options callout options (passed to verify_address())
1757 verrno where to put the address basic_errno
1759 If log_msgptr is set to something without setting user_msgptr, the caller
1760 normally uses log_msgptr for both things.
1762 Returns: result of the verification attempt: OK, FAIL, or DEFER;
1763 FAIL is given if no appropriate headers are found
1767 verify_check_header_address(uschar **user_msgptr, uschar **log_msgptr,
1768 int callout, int callout_overall, int callout_connect, uschar *se_mailfrom,
1769 uschar *pm_mailfrom, int options, int *verrno)
1771 static int header_types[] = { htype_sender, htype_reply_to, htype_from };
1776 for (i = 0; i < 3 && !done; i++)
1779 for (h = header_list; h != NULL && !done; h = h->next)
1781 int terminator, new_ok;
1782 uschar *s, *ss, *endname;
1784 if (h->type != header_types[i]) continue;
1785 s = endname = Ustrchr(h->text, ':') + 1;
1787 /* Scan the addresses in the header, enabling group syntax. Note that we
1788 have to reset this after the header has been scanned. */
1790 parse_allow_group = TRUE;
1794 address_item *vaddr;
1796 while (isspace(*s) || *s == ',') s++;
1797 if (*s == 0) break; /* End of header */
1799 ss = parse_find_address_end(s, FALSE);
1801 /* The terminator is a comma or end of header, but there may be white
1802 space preceding it (including newline for the last address). Move back
1803 past any white space so we can check against any cached envelope sender
1804 address verifications. */
1806 while (isspace(ss[-1])) ss--;
1810 HDEBUG(D_verify) debug_printf("verifying %.*s header address %s\n",
1811 (int)(endname - h->text), h->text, s);
1813 /* See if we have already verified this address as an envelope sender,
1814 and if so, use the previous answer. */
1816 vaddr = verify_checked_sender(s);
1818 if (vaddr != NULL && /* Previously checked */
1819 (callout <= 0 || /* No callout needed; OR */
1820 vaddr->special_action > 256)) /* Callout was done */
1822 new_ok = vaddr->special_action & 255;
1823 HDEBUG(D_verify) debug_printf("previously checked as envelope sender\n");
1824 *ss = terminator; /* Restore shortened string */
1827 /* Otherwise we run the verification now. We must restore the shortened
1828 string before running the verification, so the headers are correct, in
1829 case there is any rewriting. */
1833 int start, end, domain;
1834 uschar *address = parse_extract_address(s, log_msgptr, &start, &end,
1839 /* If we found an empty address, just carry on with the next one, but
1840 kill the message. */
1842 if (address == NULL && Ustrcmp(*log_msgptr, "empty address") == 0)
1849 /* If verification failed because of a syntax error, fail this
1850 function, and ensure that the failing address gets added to the error
1853 if (address == NULL)
1856 while (ss > s && isspace(ss[-1])) ss--;
1857 *log_msgptr = string_sprintf("syntax error in '%.*s' header when "
1858 "scanning for sender: %s in \"%.*s\"",
1859 endname - h->text, h->text, *log_msgptr, ss - s, s);
1865 /* Else go ahead with the sender verification. But it isn't *the*
1866 sender of the message, so set vopt_fake_sender to stop sender_address
1867 being replaced after rewriting or qualification. */
1871 vaddr = deliver_make_addr(address, FALSE);
1872 new_ok = verify_address(vaddr, NULL, options | vopt_fake_sender,
1873 callout, callout_overall, callout_connect, se_mailfrom,
1878 /* We now have the result, either newly found, or cached. If we are
1879 giving out error details, set a specific user error. This means that the
1880 last of these will be returned to the user if all three fail. We do not
1881 set a log message - the generic one below will be used. */
1885 *verrno = vaddr->basic_errno;
1886 if (smtp_return_error_details)
1888 *user_msgptr = string_sprintf("Rejected after DATA: "
1889 "could not verify \"%.*s\" header address\n%s: %s",
1890 endname - h->text, h->text, vaddr->address, vaddr->message);
1894 /* Success or defer */
1903 if (new_ok == DEFER) yield = DEFER;
1905 /* Move on to any more addresses in the header */
1908 } /* Next address */
1910 parse_allow_group = FALSE;
1911 parse_found_group = FALSE;
1912 } /* Next header, unless done */
1913 } /* Next header type unless done */
1915 if (yield == FAIL && *log_msgptr == NULL)
1916 *log_msgptr = US"there is no valid sender in any header line";
1918 if (yield == DEFER && *log_msgptr == NULL)
1919 *log_msgptr = US"all attempts to verify a sender in a header line deferred";
1927 /*************************************************
1928 * Get RFC 1413 identification *
1929 *************************************************/
1931 /* Attempt to get an id from the sending machine via the RFC 1413 protocol. If
1932 the timeout is set to zero, then the query is not done. There may also be lists
1933 of hosts and nets which are exempt. To guard against malefactors sending
1934 non-printing characters which could, for example, disrupt a message's headers,
1935 make sure the string consists of printing characters only.
1938 port the port to connect to; usually this is IDENT_PORT (113), but when
1939 running in the test harness with -bh a different value is used.
1943 Side effect: any received ident value is put in sender_ident (NULL otherwise)
1947 verify_get_ident(int port)
1949 int sock, host_af, qlen;
1950 int received_sender_port, received_interface_port, n;
1952 uschar buffer[2048];
1954 /* Default is no ident. Check whether we want to do an ident check for this
1957 sender_ident = NULL;
1958 if (rfc1413_query_timeout <= 0 || verify_check_host(&rfc1413_hosts) != OK)
1961 DEBUG(D_ident) debug_printf("doing ident callback\n");
1963 /* Set up a connection to the ident port of the remote host. Bind the local end
1964 to the incoming interface address. If the sender host address is an IPv6
1965 address, the incoming interface address will also be IPv6. */
1967 host_af = (Ustrchr(sender_host_address, ':') == NULL)? AF_INET : AF_INET6;
1968 sock = ip_socket(SOCK_STREAM, host_af);
1969 if (sock < 0) return;
1971 if (ip_bind(sock, host_af, interface_address, 0) < 0)
1973 DEBUG(D_ident) debug_printf("bind socket for ident failed: %s\n",
1978 if (ip_connect(sock, host_af, sender_host_address, port, rfc1413_query_timeout)
1981 if (errno == ETIMEDOUT && (log_extra_selector & LX_ident_timeout) != 0)
1983 log_write(0, LOG_MAIN, "ident connection to %s timed out",
1984 sender_host_address);
1988 DEBUG(D_ident) debug_printf("ident connection to %s failed: %s\n",
1989 sender_host_address, strerror(errno));
1994 /* Construct and send the query. */
1996 sprintf(CS buffer, "%d , %d\r\n", sender_host_port, interface_port);
1997 qlen = Ustrlen(buffer);
1998 if (send(sock, buffer, qlen, 0) < 0)
2000 DEBUG(D_ident) debug_printf("ident send failed: %s\n", strerror(errno));
2004 /* Read a response line. We put it into the rest of the buffer, using several
2005 recv() calls if necessary. */
2013 int size = sizeof(buffer) - (p - buffer);
2015 if (size <= 0) goto END_OFF; /* Buffer filled without seeing \n. */
2016 count = ip_recv(sock, p, size, rfc1413_query_timeout);
2017 if (count <= 0) goto END_OFF; /* Read error or EOF */
2019 /* Scan what we just read, to see if we have reached the terminating \r\n. Be
2020 generous, and accept a plain \n terminator as well. The only illegal
2023 for (pp = p; pp < p + count; pp++)
2025 if (*pp == 0) goto END_OFF; /* Zero octet not allowed */
2028 if (pp[-1] == '\r') pp--;
2030 goto GOT_DATA; /* Break out of both loops */
2034 /* Reached the end of the data without finding \n. Let the loop continue to
2035 read some more, if there is room. */
2042 /* We have received a line of data. Check it carefully. It must start with the
2043 same two port numbers that we sent, followed by data as defined by the RFC. For
2046 12345 , 25 : USERID : UNIX :root
2048 However, the amount of white space may be different to what we sent. In the
2049 "osname" field there may be several sub-fields, comma separated. The data we
2050 actually want to save follows the third colon. Some systems put leading spaces
2051 in it - we discard those. */
2053 if (sscanf(CS buffer + qlen, "%d , %d%n", &received_sender_port,
2054 &received_interface_port, &n) != 2 ||
2055 received_sender_port != sender_host_port ||
2056 received_interface_port != interface_port)
2059 p = buffer + qlen + n;
2060 while(isspace(*p)) p++;
2061 if (*p++ != ':') goto END_OFF;
2062 while(isspace(*p)) p++;
2063 if (Ustrncmp(p, "USERID", 6) != 0) goto END_OFF;
2065 while(isspace(*p)) p++;
2066 if (*p++ != ':') goto END_OFF;
2067 while (*p != 0 && *p != ':') p++;
2068 if (*p++ == 0) goto END_OFF;
2069 while(isspace(*p)) p++;
2070 if (*p == 0) goto END_OFF;
2072 /* The rest of the line is the data we want. We turn it into printing
2073 characters when we save it, so that it cannot mess up the format of any logging
2074 or Received: lines into which it gets inserted. We keep a maximum of 127
2077 sender_ident = string_printing(string_copyn(p, 127));
2078 DEBUG(D_ident) debug_printf("sender_ident = %s\n", sender_ident);
2088 /*************************************************
2089 * Match host to a single host-list item *
2090 *************************************************/
2092 /* This function compares a host (name or address) against a single item
2093 from a host list. The host name gets looked up if it is needed and is not
2094 already known. The function is called from verify_check_this_host() via
2095 match_check_list(), which is why most of its arguments are in a single block.
2098 arg the argument block (see below)
2099 ss the host-list item
2100 valueptr where to pass back looked up data, or NULL
2101 error for error message when returning ERROR
2104 host_name (a) the host name, or
2105 (b) NULL, implying use sender_host_name and
2106 sender_host_aliases, looking them up if required, or
2107 (c) the empty string, meaning that only IP address matches
2109 host_address the host address
2110 host_ipv4 the IPv4 address taken from an IPv6 one
2114 DEFER lookup deferred
2115 ERROR (a) failed to find the host name or IP address, or
2116 (b) unknown lookup type specified, or
2117 (c) host name encountered when only IP addresses are
2122 check_host(void *arg, uschar *ss, uschar **valueptr, uschar **error)
2124 check_host_block *cb = (check_host_block *)arg;
2127 BOOL iplookup = FALSE;
2128 BOOL isquery = FALSE;
2129 BOOL isiponly = cb->host_name != NULL && cb->host_name[0] == 0;
2134 /* Optimize for the special case when the pattern is "*". */
2136 if (*ss == '*' && ss[1] == 0) return OK;
2138 /* If the pattern is empty, it matches only in the case when there is no host -
2139 this can occur in ACL checking for SMTP input using the -bs option. In this
2140 situation, the host address is the empty string. */
2142 if (cb->host_address[0] == 0) return (*ss == 0)? OK : FAIL;
2143 if (*ss == 0) return FAIL;
2145 /* If the pattern is precisely "@" then match against the primary host name,
2146 provided that host name matching is permitted; if it's "@[]" match against the
2147 local host's IP addresses. */
2153 if (isiponly) return ERROR;
2154 ss = primary_hostname;
2156 else if (Ustrcmp(ss, "@[]") == 0)
2158 ip_address_item *ip;
2159 for (ip = host_find_interfaces(); ip != NULL; ip = ip->next)
2160 if (Ustrcmp(ip->address, cb->host_address) == 0) return OK;
2165 /* If the pattern is an IP address, optionally followed by a bitmask count, do
2166 a (possibly masked) comparision with the current IP address. */
2168 if (string_is_ip_address(ss, &maskoffset) != 0)
2169 return (host_is_in_net(cb->host_address, ss, maskoffset)? OK : FAIL);
2171 /* The pattern is not an IP address. A common error that people make is to omit
2172 one component of an IPv4 address, either by accident, or believing that, for
2173 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,
2174 which it isn't. (Those applications that do accept 1.2.3 as an IP address
2175 interpret it as 1.2.0.3 because the final component becomes 16-bit - this is an
2176 ancient specification.) To aid in debugging these cases, we give a specific
2177 error if the pattern contains only digits and dots or contains a slash preceded
2178 only by digits and dots (a slash at the start indicates a file name and of
2179 course slashes may be present in lookups, but not preceded only by digits and
2182 for (t = ss; isdigit(*t) || *t == '.'; t++);
2183 if (*t == 0 || (*t == '/' && t != ss))
2185 *error = US"malformed IPv4 address or address mask";
2189 /* See if there is a semicolon in the pattern */
2191 semicolon = Ustrchr(ss, ';');
2193 /* If we are doing an IP address only match, then all lookups must be IP
2194 address lookups, even if there is no "net-". */
2198 iplookup = semicolon != NULL;
2201 /* Otherwise, if the item is of the form net[n]-lookup;<file|query> then it is
2202 a lookup on a masked IP network, in textual form. We obey this code even if we
2203 have already set iplookup, so as to skip over the "net-" prefix and to set the
2204 mask length. The net- stuff really only applies to single-key lookups where the
2205 key is implicit. For query-style lookups the key is specified in the query.
2206 From release 4.30, the use of net- for query style is no longer needed, but we
2207 retain it for backward compatibility. */
2209 if (Ustrncmp(ss, "net", 3) == 0 && semicolon != NULL)
2212 for (t = ss + 3; isdigit(*t); t++) mlen = mlen * 10 + *t - '0';
2213 if (mlen == 0 && t == ss+3) mlen = -1; /* No mask supplied */
2214 iplookup = (*t++ == '-');
2218 /* Do the IP address lookup if that is indeed what we have */
2226 uschar *filename, *key, *result;
2229 /* Find the search type */
2231 search_type = search_findtype(t, semicolon - t);
2233 if (search_type < 0) log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s",
2234 search_error_message);
2236 /* Adjust parameters for the type of lookup. For a query-style lookup, there
2237 is no file name, and the "key" is just the query. For query-style with a file
2238 name, we have to fish the file off the start of the query. For a single-key
2239 lookup, the key is the current IP address, masked appropriately, and
2240 reconverted to text form, with the mask appended. For IPv6 addresses, specify
2241 dot separators instead of colons, except when the lookup type is "iplsearch".
2244 if (mac_islookup(search_type, lookup_absfilequery))
2246 filename = semicolon + 1;
2248 while (*key != 0 && !isspace(*key)) key++;
2249 filename = string_copyn(filename, key - filename);
2250 while (isspace(*key)) key++;
2252 else if (mac_islookup(search_type, lookup_querystyle))
2255 key = semicolon + 1;
2257 else /* Single-key style */
2259 int sep = (Ustrcmp(lookup_list[search_type]->name, "iplsearch") == 0)?
2261 insize = host_aton(cb->host_address, incoming);
2262 host_mask(insize, incoming, mlen);
2263 (void)host_nmtoa(insize, incoming, mlen, buffer, sep);
2265 filename = semicolon + 1;
2268 /* Now do the actual lookup; note that there is no search_close() because
2269 of the caching arrangements. */
2271 handle = search_open(filename, search_type, 0, NULL, NULL);
2272 if (handle == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s",
2273 search_error_message);
2274 result = search_find(handle, filename, key, -1, NULL, 0, 0, NULL);
2275 if (valueptr != NULL) *valueptr = result;
2276 return (result != NULL)? OK : search_find_defer? DEFER: FAIL;
2279 /* The pattern is not an IP address or network reference of any kind. That is,
2280 it is a host name pattern. If this is an IP only match, there's an error in the
2285 *error = US"cannot match host name in match_ip list";
2289 /* Check the characters of the pattern to see if they comprise only letters,
2290 digits, full stops, and hyphens (the constituents of domain names). Allow
2291 underscores, as they are all too commonly found. Sigh. Also, if
2292 allow_utf8_domains is set, allow top-bit characters. */
2294 for (t = ss; *t != 0; t++)
2295 if (!isalnum(*t) && *t != '.' && *t != '-' && *t != '_' &&
2296 (!allow_utf8_domains || *t < 128)) break;
2298 /* If the pattern is a complete domain name, with no fancy characters, look up
2299 its IP address and match against that. Note that a multi-homed host will add
2300 items to the chain. */
2311 rc = host_find_byname(&h, NULL, HOST_FIND_QUALIFY_SINGLE, NULL, FALSE);
2312 if (rc == HOST_FOUND || rc == HOST_FOUND_LOCAL)
2315 for (hh = &h; hh != NULL; hh = hh->next)
2317 if (host_is_in_net(hh->address, cb->host_address, 0)) return OK;
2321 if (rc == HOST_FIND_AGAIN) return DEFER;
2322 *error = string_sprintf("failed to find IP address for %s", ss);
2326 /* Almost all subsequent comparisons require the host name, and can be done
2327 using the general string matching function. When this function is called for
2328 outgoing hosts, the name is always given explicitly. If it is NULL, it means we
2329 must use sender_host_name and its aliases, looking them up if necessary. */
2331 if (cb->host_name != NULL) /* Explicit host name given */
2332 return match_check_string(cb->host_name, ss, -1, TRUE, TRUE, TRUE,
2335 /* Host name not given; in principle we need the sender host name and its
2336 aliases. However, for query-style lookups, we do not need the name if the
2337 query does not contain $sender_host_name. From release 4.23, a reference to
2338 $sender_host_name causes it to be looked up, so we don't need to do the lookup
2341 if ((semicolon = Ustrchr(ss, ';')) != NULL)
2344 int partial, affixlen, starflags, id;
2347 id = search_findtype_partial(ss, &partial, &affix, &affixlen, &starflags);
2350 if (id < 0) /* Unknown lookup type */
2352 log_write(0, LOG_MAIN|LOG_PANIC, "%s in host list item \"%s\"",
2353 search_error_message, ss);
2356 isquery = mac_islookup(id, lookup_querystyle|lookup_absfilequery);
2361 switch(match_check_string(US"", ss, -1, TRUE, TRUE, TRUE, valueptr))
2364 case DEFER: return DEFER;
2365 default: return FAIL;
2369 /* Not a query-style lookup; must ensure the host name is present, and then we
2370 do a check on the name and all its aliases. */
2372 if (sender_host_name == NULL)
2374 HDEBUG(D_host_lookup)
2375 debug_printf("sender host name required, to match against %s\n", ss);
2376 if (host_lookup_failed || host_name_lookup() != OK)
2378 *error = string_sprintf("failed to find host name for %s",
2379 sender_host_address);;
2382 host_build_sender_fullhost();
2385 /* Match on the sender host name, using the general matching function */
2387 switch(match_check_string(sender_host_name, ss, -1, TRUE, TRUE, TRUE,
2391 case DEFER: return DEFER;
2394 /* If there are aliases, try matching on them. */
2396 aliases = sender_host_aliases;
2397 while (*aliases != NULL)
2399 switch(match_check_string(*aliases++, ss, -1, TRUE, TRUE, TRUE, valueptr))
2402 case DEFER: return DEFER;
2411 /*************************************************
2412 * Check a specific host matches a host list *
2413 *************************************************/
2415 /* This function is passed a host list containing items in a number of
2416 different formats and the identity of a host. Its job is to determine whether
2417 the given host is in the set of hosts defined by the list. The host name is
2418 passed as a pointer so that it can be looked up if needed and not already
2419 known. This is commonly the case when called from verify_check_host() to check
2420 an incoming connection. When called from elsewhere the host name should usually
2423 This function is now just a front end to match_check_list(), which runs common
2424 code for scanning a list. We pass it the check_host() function to perform a
2428 listptr pointer to the host list
2429 cache_bits pointer to cache for named lists, or NULL
2430 host_name the host name or NULL, implying use sender_host_name and
2431 sender_host_aliases, looking them up if required
2432 host_address the IP address
2433 valueptr if not NULL, data from a lookup is passed back here
2435 Returns: OK if the host is in the defined set
2436 FAIL if the host is not in the defined set,
2437 DEFER if a data lookup deferred (not a host lookup)
2439 If the host name was needed in order to make a comparison, and could not be
2440 determined from the IP address, the result is FAIL unless the item
2441 "+allow_unknown" was met earlier in the list, in which case OK is returned. */
2444 verify_check_this_host(uschar **listptr, unsigned int *cache_bits,
2445 uschar *host_name, uschar *host_address, uschar **valueptr)
2448 unsigned int *local_cache_bits = cache_bits;
2449 uschar *save_host_address = deliver_host_address;
2450 check_host_block cb;
2451 cb.host_name = host_name;
2452 cb.host_address = host_address;
2454 if (valueptr != NULL) *valueptr = NULL;
2456 /* If the host address starts off ::ffff: it is an IPv6 address in
2457 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2460 cb.host_ipv4 = (Ustrncmp(host_address, "::ffff:", 7) == 0)?
2461 host_address + 7 : host_address;
2463 /* During the running of the check, put the IP address into $host_address. In
2464 the case of calls from the smtp transport, it will already be there. However,
2465 in other calls (e.g. when testing ignore_target_hosts), it won't. Just to be on
2466 the safe side, any existing setting is preserved, though as I write this
2467 (November 2004) I can't see any cases where it is actually needed. */
2469 deliver_host_address = host_address;
2470 rc = match_check_list(
2471 listptr, /* the list */
2472 0, /* separator character */
2473 &hostlist_anchor, /* anchor pointer */
2474 &local_cache_bits, /* cache pointer */
2475 check_host, /* function for testing */
2476 &cb, /* argument for function */
2477 MCL_HOST, /* type of check */
2478 (host_address == sender_host_address)?
2479 US"host" : host_address, /* text for debugging */
2480 valueptr); /* where to pass back data */
2481 deliver_host_address = save_host_address;
2488 /*************************************************
2489 * Check the remote host matches a list *
2490 *************************************************/
2492 /* This is a front end to verify_check_this_host(), created because checking
2493 the remote host is a common occurrence. With luck, a good compiler will spot
2494 the tail recursion and optimize it. If there's no host address, this is
2495 command-line SMTP input - check against an empty string for the address.
2498 listptr pointer to the host list
2500 Returns: the yield of verify_check_this_host(),
2501 i.e. OK, FAIL, or DEFER
2505 verify_check_host(uschar **listptr)
2507 return verify_check_this_host(listptr, sender_host_cache, NULL,
2508 (sender_host_address == NULL)? US"" : sender_host_address, NULL);
2515 /*************************************************
2516 * Invert an IP address *
2517 *************************************************/
2519 /* Originally just used for DNS xBL lists, now also used for the
2520 reverse_ip expansion operator.
2523 buffer where to put the answer
2524 address the address to invert
2528 invert_address(uschar *buffer, uschar *address)
2531 uschar *bptr = buffer;
2533 /* If this is an IPv4 address mapped into IPv6 format, adjust the pointer
2534 to the IPv4 part only. */
2536 if (Ustrncmp(address, "::ffff:", 7) == 0) address += 7;
2538 /* Handle IPv4 address: when HAVE_IPV6 is false, the result of host_aton() is
2541 if (host_aton(address, bin) == 1)
2545 for (i = 0; i < 4; i++)
2547 sprintf(CS bptr, "%d.", x & 255);
2548 while (*bptr) bptr++;
2553 /* Handle IPv6 address. Actually, as far as I know, there are no IPv6 addresses
2554 in any DNS black lists, and the format in which they will be looked up is
2555 unknown. This is just a guess. */
2561 for (j = 3; j >= 0; j--)
2564 for (i = 0; i < 8; i++)
2566 sprintf(CS bptr, "%x.", x & 15);
2567 while (*bptr) bptr++;
2574 /* Remove trailing period -- this is needed so that both arbitrary
2575 dnsbl keydomains and inverted addresses may be combined with the
2576 same format string, "%s.%s" */
2583 /*************************************************
2584 * Perform a single dnsbl lookup *
2585 *************************************************/
2587 /* This function is called from verify_check_dnsbl() below. It is also called
2588 recursively from within itself when domain and domain_txt are different
2589 pointers, in order to get the TXT record from the alternate domain.
2592 domain the outer dnsbl domain
2593 domain_txt alternate domain to lookup TXT record on success; when the
2594 same domain is to be used, domain_txt == domain (that is,
2595 the pointers must be identical, not just the text)
2596 keydomain the current keydomain (for debug message)
2597 prepend subdomain to lookup (like keydomain, but
2598 reversed if IP address)
2599 iplist the list of matching IP addresses, or NULL for "any"
2600 bitmask true if bitmask matching is wanted
2601 match_type condition for 'succeed' result
2602 0 => Any RR in iplist (=)
2603 1 => No RR in iplist (!=)
2604 2 => All RRs in iplist (==)
2605 3 => Some RRs not in iplist (!==)
2606 the two bits are defined as MT_NOT and MT_ALL
2607 defer_return what to return for a defer
2609 Returns: OK if lookup succeeded
2614 one_check_dnsbl(uschar *domain, uschar *domain_txt, uschar *keydomain,
2615 uschar *prepend, uschar *iplist, BOOL bitmask, int match_type,
2621 dnsbl_cache_block *cb;
2622 int old_pool = store_pool;
2623 uschar query[256]; /* DNS domain max length */
2625 /* Construct the specific query domainname */
2627 if (!string_format(query, sizeof(query), "%s.%s", prepend, domain))
2629 log_write(0, LOG_MAIN|LOG_PANIC, "dnslist query is too long "
2630 "(ignored): %s...", query);
2634 /* Look for this query in the cache. */
2636 t = tree_search(dnsbl_cache, query);
2638 /* If not cached from a previous lookup, we must do a DNS lookup, and
2639 cache the result in permanent memory. */
2643 store_pool = POOL_PERM;
2645 /* Set up a tree entry to cache the lookup */
2647 t = store_get(sizeof(tree_node) + Ustrlen(query));
2648 Ustrcpy(t->name, query);
2649 t->data.ptr = cb = store_get(sizeof(dnsbl_cache_block));
2650 (void)tree_insertnode(&dnsbl_cache, t);
2652 /* Do the DNS loopup . */
2654 HDEBUG(D_dnsbl) debug_printf("new DNS lookup for %s\n", query);
2655 cb->rc = dns_basic_lookup(&dnsa, query, T_A);
2656 cb->text_set = FALSE;
2660 /* If the lookup succeeded, cache the RHS address. The code allows for
2661 more than one address - this was for complete generality and the possible
2662 use of A6 records. However, A6 records have been reduced to experimental
2663 status (August 2001) and may die out. So they may never get used at all,
2664 let alone in dnsbl records. However, leave the code here, just in case.
2666 Quite apart from one A6 RR generating multiple addresses, there are DNS
2667 lists that return more than one A record, so we must handle multiple
2668 addresses generated in that way as well. */
2670 if (cb->rc == DNS_SUCCEED)
2673 dns_address **addrp = &(cb->rhs);
2674 for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
2676 rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
2678 if (rr->type == T_A)
2680 dns_address *da = dns_address_from_rr(&dnsa, rr);
2684 while (da->next != NULL) da = da->next;
2685 addrp = &(da->next);
2690 /* If we didn't find any A records, change the return code. This can
2691 happen when there is a CNAME record but there are no A records for what
2694 if (cb->rhs == NULL) cb->rc = DNS_NODATA;
2697 store_pool = old_pool;
2700 /* Previous lookup was cached */
2704 HDEBUG(D_dnsbl) debug_printf("using result of previous DNS lookup\n");
2708 /* We now have the result of the DNS lookup, either newly done, or cached
2709 from a previous call. If the lookup succeeded, check against the address
2710 list if there is one. This may be a positive equality list (introduced by
2711 "="), a negative equality list (introduced by "!="), a positive bitmask
2712 list (introduced by "&"), or a negative bitmask list (introduced by "!&").*/
2714 if (cb->rc == DNS_SUCCEED)
2716 dns_address *da = NULL;
2717 uschar *addlist = cb->rhs->address;
2719 /* For A and AAAA records, there may be multiple addresses from multiple
2720 records. For A6 records (currently not expected to be used) there may be
2721 multiple addresses from a single record. */
2723 for (da = cb->rhs->next; da != NULL; da = da->next)
2724 addlist = string_sprintf("%s, %s", addlist, da->address);
2726 HDEBUG(D_dnsbl) debug_printf("DNS lookup for %s succeeded (yielding %s)\n",
2729 /* Address list check; this can be either for equality, or via a bitmask.
2730 In the latter case, all the bits must match. */
2734 for (da = cb->rhs; da != NULL; da = da->next)
2738 uschar *ptr = iplist;
2741 /* Handle exact matching */
2745 while ((res = string_nextinlist(&ptr, &ipsep, ip, sizeof(ip))) != NULL)
2747 if (Ustrcmp(CS da->address, ip) == 0) break;
2751 /* Handle bitmask matching */
2758 /* At present, all known DNS blocking lists use A records, with
2759 IPv4 addresses on the RHS encoding the information they return. I
2760 wonder if this will linger on as the last vestige of IPv4 when IPv6
2761 is ubiquitous? Anyway, for now we use paranoia code to completely
2762 ignore IPv6 addresses. The default mask is 0, which always matches.
2763 We change this only for IPv4 addresses in the list. */
2765 if (host_aton(da->address, address) == 1) mask = address[0];
2767 /* Scan the returned addresses, skipping any that are IPv6 */
2769 while ((res = string_nextinlist(&ptr, &ipsep, ip, sizeof(ip))) != NULL)
2771 if (host_aton(ip, address) != 1) continue;
2772 if ((address[0] & mask) == address[0]) break;
2778 (a) An IP address in an any ('=') list matched, or
2779 (b) No IP address in an all ('==') list matched
2781 then we're done searching. */
2783 if (((match_type & MT_ALL) != 0) == (res == NULL)) break;
2786 /* If da == NULL, either
2788 (a) No IP address in an any ('=') list matched, or
2789 (b) An IP address in an all ('==') list didn't match
2791 so behave as if the DNSBL lookup had not succeeded, i.e. the host is not on
2794 if ((match_type == MT_NOT || match_type == MT_ALL) != (da == NULL))
2802 res = US"was no match";
2805 res = US"was an exclude match";
2808 res = US"was an IP address that did not match";
2811 res = US"were no IP addresses that did not match";
2814 debug_printf("=> but we are not accepting this block class because\n");
2815 debug_printf("=> there %s for %s%c%s\n",
2817 ((match_type & MT_ALL) == 0)? "" : "=",
2818 bitmask? '&' : '=', iplist);
2824 /* Either there was no IP list, or the record matched, implying that the
2825 domain is on the list. We now want to find a corresponding TXT record. If an
2826 alternate domain is specified for the TXT record, call this function
2827 recursively to look that up; this has the side effect of re-checking that
2828 there is indeed an A record at the alternate domain. */
2830 if (domain_txt != domain)
2831 return one_check_dnsbl(domain_txt, domain_txt, keydomain, prepend, NULL,
2832 FALSE, match_type, defer_return);
2834 /* If there is no alternate domain, look up a TXT record in the main domain
2835 if it has not previously been cached. */
2839 cb->text_set = TRUE;
2840 if (dns_basic_lookup(&dnsa, query, T_TXT) == DNS_SUCCEED)
2843 for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
2845 rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
2846 if (rr->type == T_TXT) break;
2849 int len = (rr->data)[0];
2850 if (len > 511) len = 127;
2851 store_pool = POOL_PERM;
2852 cb->text = string_sprintf("%.*s", len, (const uschar *)(rr->data+1));
2853 store_pool = old_pool;
2858 dnslist_value = addlist;
2859 dnslist_text = cb->text;
2863 /* There was a problem with the DNS lookup */
2865 if (cb->rc != DNS_NOMATCH && cb->rc != DNS_NODATA)
2867 log_write(L_dnslist_defer, LOG_MAIN,
2868 "DNS list lookup defer (probably timeout) for %s: %s", query,
2869 (defer_return == OK)? US"assumed in list" :
2870 (defer_return == FAIL)? US"assumed not in list" :
2871 US"returned DEFER");
2872 return defer_return;
2875 /* No entry was found in the DNS; continue for next domain */
2879 debug_printf("DNS lookup for %s failed\n", query);
2880 debug_printf("=> that means %s is not listed at %s\n",
2890 /*************************************************
2891 * Check host against DNS black lists *
2892 *************************************************/
2894 /* This function runs checks against a list of DNS black lists, until one
2895 matches. Each item on the list can be of the form
2897 domain=ip-address/key
2899 The domain is the right-most domain that is used for the query, for example,
2900 blackholes.mail-abuse.org. If the IP address is present, there is a match only
2901 if the DNS lookup returns a matching IP address. Several addresses may be
2902 given, comma-separated, for example: x.y.z=127.0.0.1,127.0.0.2.
2904 If no key is given, what is looked up in the domain is the inverted IP address
2905 of the current client host. If a key is given, it is used to construct the
2906 domain for the lookup. For example:
2908 dsn.rfc-ignorant.org/$sender_address_domain
2910 After finding a match in the DNS, the domain is placed in $dnslist_domain, and
2911 then we check for a TXT record for an error message, and if found, save its
2912 value in $dnslist_text. We also cache everything in a tree, to optimize
2915 The TXT record is normally looked up in the same domain as the A record, but
2916 when many lists are combined in a single DNS domain, this will not be a very
2917 specific message. It is possible to specify a different domain for looking up
2918 TXT records; this is given before the main domain, comma-separated. For
2921 dnslists = http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
2922 socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3
2924 The caching ensures that only one lookup in dnsbl.sorbs.net is done.
2926 Note: an address for testing RBL is 192.203.178.39
2927 Note: an address for testing DUL is 192.203.178.4
2928 Note: a domain for testing RFCI is example.tld.dsn.rfc-ignorant.org
2931 listptr the domain/address/data list
2933 Returns: OK successful lookup (i.e. the address is on the list), or
2934 lookup deferred after +include_unknown
2935 FAIL name not found, or no data found for the given type, or
2936 lookup deferred after +exclude_unknown (default)
2937 DEFER lookup failure, if +defer_unknown was set
2941 verify_check_dnsbl(uschar **listptr)
2944 int defer_return = FAIL;
2945 uschar *list = *listptr;
2948 uschar buffer[1024];
2949 uschar revadd[128]; /* Long enough for IPv6 address */
2951 /* Indicate that the inverted IP address is not yet set up */
2955 /* In case this is the first time the DNS resolver is being used. */
2957 dns_init(FALSE, FALSE);
2959 /* Loop through all the domains supplied, until something matches */
2961 while ((domain = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
2964 BOOL bitmask = FALSE;
2971 HDEBUG(D_dnsbl) debug_printf("DNS list check: %s\n", domain);
2973 /* Deal with special values that change the behaviour on defer */
2975 if (domain[0] == '+')
2977 if (strcmpic(domain, US"+include_unknown") == 0) defer_return = OK;
2978 else if (strcmpic(domain, US"+exclude_unknown") == 0) defer_return = FAIL;
2979 else if (strcmpic(domain, US"+defer_unknown") == 0) defer_return = DEFER;
2981 log_write(0, LOG_MAIN|LOG_PANIC, "unknown item in dnslist (ignored): %s",
2986 /* See if there's explicit data to be looked up */
2988 key = Ustrchr(domain, '/');
2989 if (key != NULL) *key++ = 0;
2991 /* See if there's a list of addresses supplied after the domain name. This is
2992 introduced by an = or a & character; if preceded by = we require all matches
2993 and if preceded by ! we invert the result. */
2995 iplist = Ustrchr(domain, '=');
2999 iplist = Ustrchr(domain, '&');
3002 if (iplist != NULL) /* Found either = or & */
3004 if (iplist > domain && iplist[-1] == '!') /* Handle preceding ! */
3006 match_type |= MT_NOT;
3010 *iplist++ = 0; /* Terminate domain, move on */
3012 /* If we found = (bitmask == FALSE), check for == or =& */
3014 if (!bitmask && (*iplist == '=' || *iplist == '&'))
3016 bitmask = *iplist++ == '&';
3017 match_type |= MT_ALL;
3021 /* If there is a comma in the domain, it indicates that a second domain for
3022 looking up TXT records is provided, before the main domain. Otherwise we must
3023 set domain_txt == domain. */
3025 domain_txt = domain;
3026 comma = Ustrchr(domain, ',');
3033 /* Check that what we have left is a sensible domain name. There is no reason
3034 why these domains should in fact use the same syntax as hosts and email
3035 domains, but in practice they seem to. However, there is little point in
3036 actually causing an error here, because that would no doubt hold up incoming
3037 mail. Instead, I'll just log it. */
3039 for (s = domain; *s != 0; s++)
3041 if (!isalnum(*s) && *s != '-' && *s != '.' && *s != '_')
3043 log_write(0, LOG_MAIN, "dnslists domain \"%s\" contains "
3044 "strange characters - is this right?", domain);
3049 /* Check the alternate domain if present */
3051 if (domain_txt != domain) for (s = domain_txt; *s != 0; s++)
3053 if (!isalnum(*s) && *s != '-' && *s != '.' && *s != '_')
3055 log_write(0, LOG_MAIN, "dnslists domain \"%s\" contains "
3056 "strange characters - is this right?", domain_txt);
3061 /* If there is no key string, construct the query by adding the domain name
3062 onto the inverted host address, and perform a single DNS lookup. */
3066 if (sender_host_address == NULL) return FAIL; /* can never match */
3067 if (revadd[0] == 0) invert_address(revadd, sender_host_address);
3068 rc = one_check_dnsbl(domain, domain_txt, sender_host_address, revadd,
3069 iplist, bitmask, match_type, defer_return);
3072 dnslist_domain = string_copy(domain_txt);
3073 dnslist_matched = string_copy(sender_host_address);
3074 HDEBUG(D_dnsbl) debug_printf("=> that means %s is listed at %s\n",
3075 sender_host_address, dnslist_domain);
3077 if (rc != FAIL) return rc; /* OK or DEFER */
3080 /* If there is a key string, it can be a list of domains or IP addresses to
3081 be concatenated with the main domain. */
3088 uschar keybuffer[256];
3089 uschar keyrevadd[128];
3091 while ((keydomain = string_nextinlist(&key, &keysep, keybuffer,
3092 sizeof(keybuffer))) != NULL)
3094 uschar *prepend = keydomain;
3096 if (string_is_ip_address(keydomain, NULL) != 0)
3098 invert_address(keyrevadd, keydomain);
3099 prepend = keyrevadd;
3102 rc = one_check_dnsbl(domain, domain_txt, keydomain, prepend, iplist,
3103 bitmask, match_type, defer_return);
3107 dnslist_domain = string_copy(domain_txt);
3108 dnslist_matched = string_copy(keydomain);
3109 HDEBUG(D_dnsbl) debug_printf("=> that means %s is listed at %s\n",
3110 keydomain, dnslist_domain);
3114 /* If the lookup deferred, remember this fact. We keep trying the rest
3115 of the list to see if we get a useful result, and if we don't, we return
3116 DEFER at the end. */
3118 if (rc == DEFER) defer = TRUE;
3119 } /* continue with next keystring domain/address */
3121 if (defer) return DEFER;
3123 } /* continue with next dnsdb outer domain */
3128 /* End of verify.c */