1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2009 */
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). */
15 /* Structure for caching DNSBL lookups */
17 typedef struct dnsbl_cache_block {
25 /* Anchor for DNSBL cache */
27 static tree_node *dnsbl_cache = NULL;
30 /* Bits for match_type in one_check_dnsbl() */
37 /*************************************************
38 * Retrieve a callout cache record *
39 *************************************************/
41 /* If a record exists, check whether it has expired.
44 dbm_file an open hints file
46 type "address" or "domain"
47 positive_expire expire time for positive records
48 negative_expire expire time for negative records
50 Returns: the cache record if a non-expired one exists, else NULL
53 static dbdata_callout_cache *
54 get_callout_cache_record(open_db *dbm_file, uschar *key, uschar *type,
55 int positive_expire, int negative_expire)
60 dbdata_callout_cache *cache_record;
62 cache_record = dbfn_read_with_length(dbm_file, key, &length);
64 if (cache_record == NULL)
66 HDEBUG(D_verify) debug_printf("callout cache: no %s record found\n", type);
70 /* We treat a record as "negative" if its result field is not positive, or if
71 it is a domain record and the postmaster field is negative. */
73 negative = cache_record->result != ccache_accept ||
74 (type[0] == 'd' && cache_record->postmaster_result == ccache_reject);
75 expire = negative? negative_expire : positive_expire;
78 if (now - cache_record->time_stamp > expire)
80 HDEBUG(D_verify) debug_printf("callout cache: %s record expired\n", type);
84 /* If this is a non-reject domain record, check for the obsolete format version
85 that doesn't have the postmaster and random timestamps, by looking at the
86 length. If so, copy it to a new-style block, replicating the record's
87 timestamp. Then check the additional timestamps. (There's no point wasting
88 effort if connections are rejected.) */
90 if (type[0] == 'd' && cache_record->result != ccache_reject)
92 if (length == sizeof(dbdata_callout_cache_obs))
94 dbdata_callout_cache *new = store_get(sizeof(dbdata_callout_cache));
95 memcpy(new, cache_record, length);
96 new->postmaster_stamp = new->random_stamp = new->time_stamp;
100 if (now - cache_record->postmaster_stamp > expire)
101 cache_record->postmaster_result = ccache_unknown;
103 if (now - cache_record->random_stamp > expire)
104 cache_record->random_result = ccache_unknown;
107 HDEBUG(D_verify) debug_printf("callout cache: found %s record\n", type);
113 /*************************************************
114 * Do callout verification for an address *
115 *************************************************/
117 /* This function is called from verify_address() when the address has routed to
118 a host list, and a callout has been requested. Callouts are expensive; that is
119 why a cache is used to improve the efficiency.
122 addr the address that's been routed
123 host_list the list of hosts to try
124 tf the transport feedback block
126 ifstring "interface" option from transport, or NULL
127 portstring "port" option from transport, or NULL
128 protocolstring "protocol" option from transport, or NULL
129 callout the per-command callout timeout
130 callout_overall the overall callout timeout (if < 0 use 4*callout)
131 callout_connect the callout connection timeout (if < 0 use callout)
132 options the verification options - these bits are used:
133 vopt_is_recipient => this is a recipient address
134 vopt_callout_no_cache => don't use callout cache
135 vopt_callout_fullpm => if postmaster check, do full one
136 vopt_callout_random => do the "random" thing
137 vopt_callout_recipsender => use real sender for recipient
138 vopt_callout_recippmaster => use postmaster for recipient
139 se_mailfrom MAIL FROM address for sender verify; NULL => ""
140 pm_mailfrom if non-NULL, do the postmaster check with this sender
142 Returns: OK/FAIL/DEFER
146 do_callout(address_item *addr, host_item *host_list, transport_feedback *tf,
147 int callout, int callout_overall, int callout_connect, int options,
148 uschar *se_mailfrom, uschar *pm_mailfrom)
150 BOOL is_recipient = (options & vopt_is_recipient) != 0;
151 BOOL callout_no_cache = (options & vopt_callout_no_cache) != 0;
152 BOOL callout_random = (options & vopt_callout_random) != 0;
155 int old_domain_cache_result = ccache_accept;
158 uschar *from_address;
159 uschar *random_local_part = NULL;
160 uschar *save_deliver_domain = deliver_domain;
161 uschar **failure_ptr = is_recipient?
162 &recipient_verify_failure : &sender_verify_failure;
164 open_db *dbm_file = NULL;
165 dbdata_callout_cache new_domain_record;
166 dbdata_callout_cache_address new_address_record;
168 time_t callout_start_time;
170 new_domain_record.result = ccache_unknown;
171 new_domain_record.postmaster_result = ccache_unknown;
172 new_domain_record.random_result = ccache_unknown;
174 memset(&new_address_record, 0, sizeof(new_address_record));
176 /* For a recipient callout, the key used for the address cache record must
177 include the sender address if we are using the real sender in the callout,
178 because that may influence the result of the callout. */
180 address_key = addr->address;
185 if ((options & vopt_callout_recipsender) != 0)
187 address_key = string_sprintf("%s/<%s>", addr->address, sender_address);
188 from_address = sender_address;
190 else if ((options & vopt_callout_recippmaster) != 0)
192 address_key = string_sprintf("%s/<postmaster@%s>", addr->address,
193 qualify_domain_sender);
194 from_address = string_sprintf("postmaster@%s", qualify_domain_sender);
198 /* For a sender callout, we must adjust the key if the mailfrom address is not
203 from_address = (se_mailfrom == NULL)? US"" : se_mailfrom;
204 if (from_address[0] != 0)
205 address_key = string_sprintf("%s/<%s>", addr->address, from_address);
208 /* Open the callout cache database, it it exists, for reading only at this
209 stage, unless caching has been disabled. */
211 if (callout_no_cache)
213 HDEBUG(D_verify) debug_printf("callout cache: disabled by no_cache\n");
215 else if ((dbm_file = dbfn_open(US"callout", O_RDWR, &dbblock, FALSE)) == NULL)
217 HDEBUG(D_verify) debug_printf("callout cache: not available\n");
220 /* If a cache database is available see if we can avoid the need to do an
221 actual callout by making use of previously-obtained data. */
223 if (dbm_file != NULL)
225 dbdata_callout_cache_address *cache_address_record;
226 dbdata_callout_cache *cache_record = get_callout_cache_record(dbm_file,
227 addr->domain, US"domain",
228 callout_cache_domain_positive_expire,
229 callout_cache_domain_negative_expire);
231 /* If an unexpired cache record was found for this domain, see if the callout
232 process can be short-circuited. */
234 if (cache_record != NULL)
236 /* In most cases, if an early command (up to and including MAIL FROM:<>)
237 was rejected, there is no point carrying on. The callout fails. However, if
238 we are doing a recipient verification with use_sender or use_postmaster
239 set, a previous failure of MAIL FROM:<> doesn't count, because this time we
240 will be using a non-empty sender. We have to remember this situation so as
241 not to disturb the cached domain value if this whole verification succeeds
242 (we don't want it turning into "accept"). */
244 old_domain_cache_result = cache_record->result;
246 if (cache_record->result == ccache_reject ||
247 (*from_address == 0 && cache_record->result == ccache_reject_mfnull))
249 setflag(addr, af_verify_nsfail);
251 debug_printf("callout cache: domain gave initial rejection, or "
252 "does not accept HELO or MAIL FROM:<>\n");
253 setflag(addr, af_verify_nsfail);
254 addr->user_message = US"(result of an earlier callout reused).";
256 *failure_ptr = US"mail";
260 /* If a previous check on a "random" local part was accepted, we assume
261 that the server does not do any checking on local parts. There is therefore
262 no point in doing the callout, because it will always be successful. If a
263 random check previously failed, arrange not to do it again, but preserve
264 the data in the new record. If a random check is required but hasn't been
265 done, skip the remaining cache processing. */
267 if (callout_random) switch(cache_record->random_result)
271 debug_printf("callout cache: domain accepts random addresses\n");
272 goto END_CALLOUT; /* Default yield is OK */
276 debug_printf("callout cache: domain rejects random addresses\n");
277 callout_random = FALSE;
278 new_domain_record.random_result = ccache_reject;
279 new_domain_record.random_stamp = cache_record->random_stamp;
284 debug_printf("callout cache: need to check random address handling "
285 "(not cached or cache expired)\n");
289 /* If a postmaster check is requested, but there was a previous failure,
290 there is again no point in carrying on. If a postmaster check is required,
291 but has not been done before, we are going to have to do a callout, so skip
292 remaining cache processing. */
294 if (pm_mailfrom != NULL)
296 if (cache_record->postmaster_result == ccache_reject)
298 setflag(addr, af_verify_pmfail);
300 debug_printf("callout cache: domain does not accept "
301 "RCPT TO:<postmaster@domain>\n");
303 *failure_ptr = US"postmaster";
304 setflag(addr, af_verify_pmfail);
305 addr->user_message = US"(result of earlier verification reused).";
308 if (cache_record->postmaster_result == ccache_unknown)
311 debug_printf("callout cache: need to check RCPT "
312 "TO:<postmaster@domain> (not cached or cache expired)\n");
316 /* If cache says OK, set pm_mailfrom NULL to prevent a redundant
317 postmaster check if the address itself has to be checked. Also ensure
318 that the value in the cache record is preserved (with its old timestamp).
321 HDEBUG(D_verify) debug_printf("callout cache: domain accepts RCPT "
322 "TO:<postmaster@domain>\n");
324 new_domain_record.postmaster_result = ccache_accept;
325 new_domain_record.postmaster_stamp = cache_record->postmaster_stamp;
329 /* We can't give a result based on information about the domain. See if there
330 is an unexpired cache record for this specific address (combined with the
331 sender address if we are doing a recipient callout with a non-empty sender).
334 cache_address_record = (dbdata_callout_cache_address *)
335 get_callout_cache_record(dbm_file,
336 address_key, US"address",
337 callout_cache_positive_expire,
338 callout_cache_negative_expire);
340 if (cache_address_record != NULL)
342 if (cache_address_record->result == ccache_accept)
345 debug_printf("callout cache: address record is positive\n");
350 debug_printf("callout cache: address record is negative\n");
351 addr->user_message = US"Previous (cached) callout verification failure";
352 *failure_ptr = US"recipient";
358 /* Close the cache database while we actually do the callout for real. */
361 dbfn_close(dbm_file);
365 /* The information wasn't available in the cache, so we have to do a real
366 callout and save the result in the cache for next time, unless no_cache is set,
367 or unless we have a previously cached negative random result. If we are to test
368 with a random local part, ensure that such a local part is available. If not,
369 log the fact, but carry on without randomming. */
371 if (callout_random && callout_random_local_part != NULL)
373 random_local_part = expand_string(callout_random_local_part);
374 if (random_local_part == NULL)
375 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand "
376 "callout_random_local_part: %s", expand_string_message);
379 /* Default the connect and overall callout timeouts if not set, and record the
380 time we are starting so that we can enforce it. */
382 if (callout_overall < 0) callout_overall = 4 * callout;
383 if (callout_connect < 0) callout_connect = callout;
384 callout_start_time = time(NULL);
386 /* Before doing a real callout, if this is an SMTP connection, flush the SMTP
387 output because a callout might take some time. When PIPELINING is active and
388 there are many recipients, the total time for doing lots of callouts can add up
389 and cause the client to time out. So in this case we forgo the PIPELINING
392 if (smtp_out != NULL && !disable_callout_flush) mac_smtp_fflush();
394 /* Now make connections to the hosts and do real callouts. The list of hosts
395 is passed in as an argument. */
397 for (host = host_list; host != NULL && !done; host = host->next)
399 smtp_inblock inblock;
400 smtp_outblock outblock;
403 BOOL send_quit = TRUE;
404 uschar *active_hostname = smtp_active_hostname;
405 uschar *helo = US"HELO";
406 uschar *interface = NULL; /* Outgoing interface to use; NULL => any */
407 uschar inbuffer[4096];
408 uschar outbuffer[1024];
409 uschar responsebuffer[4096];
411 clearflag(addr, af_verify_pmfail); /* postmaster callout flag */
412 clearflag(addr, af_verify_nsfail); /* null sender callout flag */
414 /* Skip this host if we don't have an IP address for it. */
416 if (host->address == NULL)
418 DEBUG(D_verify) debug_printf("no IP address for host name %s: skipping\n",
423 /* Check the overall callout timeout */
425 if (time(NULL) - callout_start_time >= callout_overall)
427 HDEBUG(D_verify) debug_printf("overall timeout for callout exceeded\n");
431 /* Set IPv4 or IPv6 */
433 host_af = (Ustrchr(host->address, ':') == NULL)? AF_INET:AF_INET6;
435 /* Expand and interpret the interface and port strings. The latter will not
436 be used if there is a host-specific port (e.g. from a manualroute router).
437 This has to be delayed till now, because they may expand differently for
438 different hosts. If there's a failure, log it, but carry on with the
441 deliver_host = host->name;
442 deliver_host_address = host->address;
443 deliver_domain = addr->domain;
445 if (!smtp_get_interface(tf->interface, host_af, addr, NULL, &interface,
447 !smtp_get_port(tf->port, addr, &port, US"callout"))
448 log_write(0, LOG_MAIN|LOG_PANIC, "<%s>: %s", addr->address,
451 /* Set HELO string according to the protocol */
453 if (Ustrcmp(tf->protocol, "lmtp") == 0) helo = US"LHLO";
455 HDEBUG(D_verify) debug_printf("interface=%s port=%d\n", interface, port);
457 /* Set up the buffer for reading SMTP response packets. */
459 inblock.buffer = inbuffer;
460 inblock.buffersize = sizeof(inbuffer);
461 inblock.ptr = inbuffer;
462 inblock.ptrend = inbuffer;
464 /* Set up the buffer for holding SMTP commands while pipelining */
466 outblock.buffer = outbuffer;
467 outblock.buffersize = sizeof(outbuffer);
468 outblock.ptr = outbuffer;
469 outblock.cmd_count = 0;
470 outblock.authenticating = FALSE;
472 /* Connect to the host; on failure, just loop for the next one, but we
473 set the error for the last one. Use the callout_connect timeout. */
475 inblock.sock = outblock.sock =
476 smtp_connect(host, host_af, port, interface, callout_connect, TRUE);
477 if (inblock.sock < 0)
479 addr->message = string_sprintf("could not connect to %s [%s]: %s",
480 host->name, host->address, strerror(errno));
481 deliver_host = deliver_host_address = NULL;
482 deliver_domain = save_deliver_domain;
486 /* Expand the helo_data string to find the host name to use. */
488 if (tf->helo_data != NULL)
490 uschar *s = expand_string(tf->helo_data);
492 log_write(0, LOG_MAIN|LOG_PANIC, "<%s>: failed to expand transport's "
493 "helo_data value for callout: %s", addr->address,
494 expand_string_message);
495 else active_hostname = s;
498 deliver_host = deliver_host_address = NULL;
499 deliver_domain = save_deliver_domain;
501 /* Wait for initial response, and send HELO. The smtp_write_command()
502 function leaves its command in big_buffer. This is used in error responses.
503 Initialize it in case the connection is rejected. */
505 Ustrcpy(big_buffer, "initial connection");
508 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
510 smtp_write_command(&outblock, FALSE, "%s %s\r\n", helo,
511 active_hostname) >= 0 &&
512 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
515 /* Failure to accept HELO is cached; this blocks the whole domain for all
516 senders. I/O errors and defer responses are not cached. */
520 *failure_ptr = US"mail"; /* At or before MAIL */
521 if (errno == 0 && responsebuffer[0] == '5')
523 setflag(addr, af_verify_nsfail);
524 new_domain_record.result = ccache_reject;
528 /* Send the MAIL command */
531 smtp_write_command(&outblock, FALSE, "MAIL FROM:<%s>\r\n",
532 from_address) >= 0 &&
533 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
536 /* If the host does not accept MAIL FROM:<>, arrange to cache this
537 information, but again, don't record anything for an I/O error or a defer. Do
538 not cache rejections of MAIL when a non-empty sender has been used, because
539 that blocks the whole domain for all senders. */
543 *failure_ptr = US"mail"; /* At or before MAIL */
544 if (errno == 0 && responsebuffer[0] == '5')
546 setflag(addr, af_verify_nsfail);
547 if (from_address[0] == 0)
548 new_domain_record.result = ccache_reject_mfnull;
552 /* Otherwise, proceed to check a "random" address (if required), then the
553 given address, and the postmaster address (if required). Between each check,
554 issue RSET, because some servers accept only one recipient after MAIL
557 Before doing this, set the result in the domain cache record to "accept",
558 unless its previous value was ccache_reject_mfnull. In that case, the domain
559 rejects MAIL FROM:<> and we want to continue to remember that. When that is
560 the case, we have got here only in the case of a recipient verification with
561 a non-null sender. */
565 new_domain_record.result =
566 (old_domain_cache_result == ccache_reject_mfnull)?
567 ccache_reject_mfnull: ccache_accept;
569 /* Do the random local part check first */
571 if (random_local_part != NULL)
573 uschar randombuffer[1024];
575 smtp_write_command(&outblock, FALSE,
576 "RCPT TO:<%.1000s@%.1000s>\r\n", random_local_part,
577 addr->domain) >= 0 &&
578 smtp_read_response(&inblock, randombuffer,
579 sizeof(randombuffer), '2', callout);
581 /* Remember when we last did a random test */
583 new_domain_record.random_stamp = time(NULL);
585 /* If accepted, we aren't going to do any further tests below. */
589 new_domain_record.random_result = ccache_accept;
592 /* Otherwise, cache a real negative response, and get back to the right
593 state to send RCPT. Unless there's some problem such as a dropped
594 connection, we expect to succeed, because the commands succeeded above. */
598 if (randombuffer[0] == '5')
599 new_domain_record.random_result = ccache_reject;
602 smtp_write_command(&outblock, FALSE, "RSET\r\n") >= 0 &&
603 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
606 smtp_write_command(&outblock, FALSE, "MAIL FROM:<%s>\r\n",
607 from_address) >= 0 &&
608 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
611 else done = FALSE; /* Some timeout/connection problem */
614 /* If the host is accepting all local parts, as determined by the "random"
615 check, we don't need to waste time doing any further checking. */
617 if (new_domain_record.random_result != ccache_accept && done)
619 /* Get the rcpt_include_affixes flag from the transport if there is one,
620 but assume FALSE if there is not. */
623 smtp_write_command(&outblock, FALSE, "RCPT TO:<%.1000s>\r\n",
624 transport_rcpt_address(addr,
625 (addr->transport == NULL)? FALSE :
626 addr->transport->rcpt_include_affixes)) >= 0 &&
627 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
631 new_address_record.result = ccache_accept;
632 else if (errno == 0 && responsebuffer[0] == '5')
634 *failure_ptr = US"recipient";
635 new_address_record.result = ccache_reject;
638 /* Do postmaster check if requested; if a full check is required, we
639 check for RCPT TO:<postmaster> (no domain) in accordance with RFC 821. */
641 if (done && pm_mailfrom != NULL)
644 smtp_write_command(&outblock, FALSE, "RSET\r\n") >= 0 &&
645 smtp_read_response(&inblock, responsebuffer,
646 sizeof(responsebuffer), '2', callout) &&
648 smtp_write_command(&outblock, FALSE,
649 "MAIL FROM:<%s>\r\n", pm_mailfrom) >= 0 &&
650 smtp_read_response(&inblock, responsebuffer,
651 sizeof(responsebuffer), '2', callout) &&
653 /* First try using the current domain */
656 smtp_write_command(&outblock, FALSE,
657 "RCPT TO:<postmaster@%.1000s>\r\n", addr->domain) >= 0 &&
658 smtp_read_response(&inblock, responsebuffer,
659 sizeof(responsebuffer), '2', callout)
664 /* If that doesn't work, and a full check is requested,
665 try without the domain. */
668 (options & vopt_callout_fullpm) != 0 &&
669 smtp_write_command(&outblock, FALSE,
670 "RCPT TO:<postmaster>\r\n") >= 0 &&
671 smtp_read_response(&inblock, responsebuffer,
672 sizeof(responsebuffer), '2', callout)
675 /* Sort out the cache record */
677 new_domain_record.postmaster_stamp = time(NULL);
680 new_domain_record.postmaster_result = ccache_accept;
681 else if (errno == 0 && responsebuffer[0] == '5')
683 *failure_ptr = US"postmaster";
684 setflag(addr, af_verify_pmfail);
685 new_domain_record.postmaster_result = ccache_reject;
688 } /* Random not accepted */
689 } /* MAIL FROM: accepted */
691 /* For any failure of the main check, other than a negative response, we just
692 close the connection and carry on. We can identify a negative response by the
693 fact that errno is zero. For I/O errors it will be non-zero
695 Set up different error texts for logging and for sending back to the caller
696 as an SMTP response. Log in all cases, using a one-line format. For sender
697 callouts, give a full response to the caller, but for recipient callouts,
698 don't give the IP address because this may be an internal host whose identity
699 is not to be widely broadcast. */
703 if (errno == ETIMEDOUT)
705 HDEBUG(D_verify) debug_printf("SMTP timeout\n");
710 if (*responsebuffer == 0) Ustrcpy(responsebuffer, US"connection dropped");
713 string_sprintf("response to \"%s\" from %s [%s] was: %s",
714 big_buffer, host->name, host->address,
715 string_printing(responsebuffer));
717 addr->user_message = is_recipient?
718 string_sprintf("Callout verification failed:\n%s", responsebuffer)
720 string_sprintf("Called: %s\nSent: %s\nResponse: %s",
721 host->address, big_buffer, responsebuffer);
723 /* Hard rejection ends the process */
725 if (responsebuffer[0] == '5') /* Address rejected */
733 /* End the SMTP conversation and close the connection. */
735 if (send_quit) (void)smtp_write_command(&outblock, FALSE, "QUIT\r\n");
736 (void)close(inblock.sock);
737 } /* Loop through all hosts, while !done */
739 /* If we get here with done == TRUE, a successful callout happened, and yield
740 will be set OK or FAIL according to the response to the RCPT command.
741 Otherwise, we looped through the hosts but couldn't complete the business.
742 However, there may be domain-specific information to cache in both cases.
744 The value of the result field in the new_domain record is ccache_unknown if
745 there was an error before or with MAIL FROM:, and errno was not zero,
746 implying some kind of I/O error. We don't want to write the cache in that case.
747 Otherwise the value is ccache_accept, ccache_reject, or ccache_reject_mfnull. */
749 if (!callout_no_cache && new_domain_record.result != ccache_unknown)
751 if ((dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE))
754 HDEBUG(D_verify) debug_printf("callout cache: not available\n");
758 (void)dbfn_write(dbm_file, addr->domain, &new_domain_record,
759 (int)sizeof(dbdata_callout_cache));
760 HDEBUG(D_verify) debug_printf("wrote callout cache domain record:\n"
761 " result=%d postmaster=%d random=%d\n",
762 new_domain_record.result,
763 new_domain_record.postmaster_result,
764 new_domain_record.random_result);
768 /* If a definite result was obtained for the callout, cache it unless caching
773 if (!callout_no_cache && new_address_record.result != ccache_unknown)
775 if (dbm_file == NULL)
776 dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE);
777 if (dbm_file == NULL)
779 HDEBUG(D_verify) debug_printf("no callout cache available\n");
783 (void)dbfn_write(dbm_file, address_key, &new_address_record,
784 (int)sizeof(dbdata_callout_cache_address));
785 HDEBUG(D_verify) debug_printf("wrote %s callout cache address record\n",
786 (new_address_record.result == ccache_accept)? "positive" : "negative");
791 /* Failure to connect to any host, or any response other than 2xx or 5xx is a
792 temporary error. If there was only one host, and a response was received, leave
793 it alone if supplying details. Otherwise, give a generic response. */
797 uschar *dullmsg = string_sprintf("Could not complete %s verify callout",
798 is_recipient? "recipient" : "sender");
801 if (host_list->next != NULL || addr->message == NULL) addr->message = dullmsg;
803 addr->user_message = (!smtp_return_error_details)? dullmsg :
804 string_sprintf("%s for <%s>.\n"
805 "The mail server(s) for the domain may be temporarily unreachable, or\n"
806 "they may be permanently unreachable from this server. In the latter case,\n%s",
807 dullmsg, addr->address,
809 "the address will never be accepted."
811 "you need to change the address or create an MX record for its domain\n"
812 "if it is supposed to be generally accessible from the Internet.\n"
813 "Talk to your mail administrator for details.");
815 /* Force a specific error code */
817 addr->basic_errno = ERRNO_CALLOUTDEFER;
820 /* Come here from within the cache-reading code on fast-track exit. */
823 if (dbm_file != NULL) dbfn_close(dbm_file);
829 /*************************************************
830 * Copy error to toplevel address *
831 *************************************************/
833 /* This function is used when a verify fails or defers, to ensure that the
834 failure or defer information is in the original toplevel address. This applies
835 when an address is redirected to a single new address, and the failure or
836 deferral happens to the child address.
839 vaddr the verify address item
840 addr the final address item
843 Returns: the value of YIELD
847 copy_error(address_item *vaddr, address_item *addr, int yield)
851 vaddr->message = addr->message;
852 vaddr->user_message = addr->user_message;
853 vaddr->basic_errno = addr->basic_errno;
854 vaddr->more_errno = addr->more_errno;
855 vaddr->p.address_data = addr->p.address_data;
856 copyflag(vaddr, addr, af_pass_message);
864 /**************************************************
865 * printf that automatically handles TLS if needed *
866 ***************************************************/
868 /* This function is used by verify_address() as a substitute for all fprintf()
869 calls; a direct fprintf() will not produce output in a TLS SMTP session, such
870 as a response to an EXPN command. smtp_in.c makes smtp_printf available but
871 that assumes that we always use the smtp_out FILE* when not using TLS or the
872 ssl buffer when we are. Instead we take a FILE* parameter and check to see if
873 that is smtp_out; if so, smtp_printf() with TLS support, otherwise regular
877 f the candidate FILE* to write to
879 ... optional arguments
885 static void PRINTF_FUNCTION(2,3)
886 respond_printf(FILE *f, const char *format, ...)
890 va_start(ap, format);
891 if (smtp_out && (f == smtp_out))
892 smtp_vprintf(format, ap);
894 vfprintf(f, format, ap);
900 /*************************************************
901 * Verify an email address *
902 *************************************************/
904 /* This function is used both for verification (-bv and at other times) and
905 address testing (-bt), which is indicated by address_test_mode being set.
908 vaddr contains the address to verify; the next field in this block
910 f if not NULL, write the result to this file
911 options various option bits:
912 vopt_fake_sender => this sender verify is not for the real
913 sender (it was verify=sender=xxxx or an address from a
914 header line) - rewriting must not change sender_address
915 vopt_is_recipient => this is a recipient address, otherwise
916 it's a sender address - this affects qualification and
917 rewriting and messages from callouts
918 vopt_qualify => qualify an unqualified address; else error
919 vopt_expn => called from SMTP EXPN command
920 vopt_success_on_redirect => when a new address is generated
921 the verification instantly succeeds
923 These ones are used by do_callout() -- the options variable
926 vopt_callout_fullpm => if postmaster check, do full one
927 vopt_callout_no_cache => don't use callout cache
928 vopt_callout_random => do the "random" thing
929 vopt_callout_recipsender => use real sender for recipient
930 vopt_callout_recippmaster => use postmaster for recipient
932 callout if > 0, specifies that callout is required, and gives timeout
933 for individual commands
934 callout_overall if > 0, gives overall timeout for the callout function;
935 if < 0, a default is used (see do_callout())
936 callout_connect the connection timeout for callouts
937 se_mailfrom when callout is requested to verify a sender, use this
938 in MAIL FROM; NULL => ""
939 pm_mailfrom when callout is requested, if non-NULL, do the postmaster
940 thing and use this as the sender address (may be "")
942 routed if not NULL, set TRUE if routing succeeded, so we can
943 distinguish between routing failed and callout failed
945 Returns: OK address verified
946 FAIL address failed to verify
947 DEFER can't tell at present
951 verify_address(address_item *vaddr, FILE *f, int options, int callout,
952 int callout_overall, int callout_connect, uschar *se_mailfrom,
953 uschar *pm_mailfrom, BOOL *routed)
956 BOOL full_info = (f == NULL)? FALSE : (debug_selector != 0);
957 BOOL is_recipient = (options & vopt_is_recipient) != 0;
958 BOOL expn = (options & vopt_expn) != 0;
959 BOOL success_on_redirect = (options & vopt_success_on_redirect) != 0;
962 int verify_type = expn? v_expn :
963 address_test_mode? v_none :
964 is_recipient? v_recipient : v_sender;
965 address_item *addr_list;
966 address_item *addr_new = NULL;
967 address_item *addr_remote = NULL;
968 address_item *addr_local = NULL;
969 address_item *addr_succeed = NULL;
970 uschar **failure_ptr = is_recipient?
971 &recipient_verify_failure : &sender_verify_failure;
972 uschar *ko_prefix, *cr;
973 uschar *address = vaddr->address;
975 uschar null_sender[] = { 0 }; /* Ensure writeable memory */
977 /* Clear, just in case */
981 /* Set up a prefix and suffix for error message which allow us to use the same
982 output statements both in EXPN mode (where an SMTP response is needed) and when
983 debugging with an output file. */
987 ko_prefix = US"553 ";
990 else ko_prefix = cr = US"";
992 /* Add qualify domain if permitted; otherwise an unqualified address fails. */
994 if (parse_find_at(address) == NULL)
996 if ((options & vopt_qualify) == 0)
999 respond_printf(f, "%sA domain is required for \"%s\"%s\n",
1000 ko_prefix, address, cr);
1001 *failure_ptr = US"qualify";
1004 address = rewrite_address_qualify(address, is_recipient);
1009 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
1010 debug_printf("%s %s\n", address_test_mode? "Testing" : "Verifying", address);
1013 /* Rewrite and report on it. Clear the domain and local part caches - these
1014 may have been set by domains and local part tests during an ACL. */
1016 if (global_rewrite_rules != NULL)
1018 uschar *old = address;
1019 address = rewrite_address(address, is_recipient, FALSE,
1020 global_rewrite_rules, rewrite_existflags);
1023 for (i = 0; i < (MAX_NAMED_LIST * 2)/32; i++) vaddr->localpart_cache[i] = 0;
1024 for (i = 0; i < (MAX_NAMED_LIST * 2)/32; i++) vaddr->domain_cache[i] = 0;
1025 if (f != NULL && !expn) fprintf(f, "Address rewritten as: %s\n", address);
1029 /* If this is the real sender address, we must update sender_address at
1030 this point, because it may be referred to in the routers. */
1032 if ((options & (vopt_fake_sender|vopt_is_recipient)) == 0)
1033 sender_address = address;
1035 /* If the address was rewritten to <> no verification can be done, and we have
1036 to return OK. This rewriting is permitted only for sender addresses; for other
1037 addresses, such rewriting fails. */
1039 if (address[0] == 0) return OK;
1041 /* Save a copy of the sender address for re-instating if we change it to <>
1042 while verifying a sender address (a nice bit of self-reference there). */
1044 save_sender = sender_address;
1046 /* Update the address structure with the possibly qualified and rewritten
1047 address. Set it up as the starting address on the chain of new addresses. */
1049 vaddr->address = address;
1052 /* We need a loop, because an address can generate new addresses. We must also
1053 cope with generated pipes and files at the top level. (See also the code and
1054 comment in deliver.c.) However, it is usually the case that the router for
1055 user's .forward files has its verify flag turned off.
1057 If an address generates more than one child, the loop is used only when
1058 full_info is set, and this can only be set locally. Remote enquiries just get
1059 information about the top level address, not anything that it generated. */
1061 while (addr_new != NULL)
1064 address_item *addr = addr_new;
1066 addr_new = addr->next;
1071 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
1072 debug_printf("Considering %s\n", addr->address);
1075 /* Handle generated pipe, file or reply addresses. We don't get these
1076 when handling EXPN, as it does only one level of expansion. */
1078 if (testflag(addr, af_pfr))
1085 if (addr->address[0] == '>')
1087 allow = testflag(addr, af_allow_reply);
1088 fprintf(f, "%s -> mail %s", addr->parent->address, addr->address + 1);
1092 allow = (addr->address[0] == '|')?
1093 testflag(addr, af_allow_pipe) : testflag(addr, af_allow_file);
1094 fprintf(f, "%s -> %s", addr->parent->address, addr->address);
1097 if (addr->basic_errno == ERRNO_BADTRANSPORT)
1098 fprintf(f, "\n*** Error in setting up pipe, file, or autoreply:\n"
1099 "%s\n", addr->message);
1101 fprintf(f, "\n transport = %s\n", addr->transport->name);
1103 fprintf(f, " *** forbidden ***\n");
1108 /* Just in case some router parameter refers to it. */
1110 return_path = (addr->p.errors_address != NULL)?
1111 addr->p.errors_address : sender_address;
1113 /* Split the address into domain and local part, handling the %-hack if
1114 necessary, and then route it. While routing a sender address, set
1115 $sender_address to <> because that is what it will be if we were trying to
1116 send a bounce to the sender. */
1118 if (routed != NULL) *routed = FALSE;
1119 if ((rc = deliver_split_address(addr)) == OK)
1121 if (!is_recipient) sender_address = null_sender;
1122 rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
1123 &addr_succeed, verify_type);
1124 sender_address = save_sender; /* Put back the real sender */
1127 /* If routing an address succeeded, set the flag that remembers, for use when
1128 an ACL cached a sender verify (in case a callout fails). Then if routing set
1129 up a list of hosts or the transport has a host list, and the callout option
1130 is set, and we aren't in a host checking run, do the callout verification,
1131 and set another flag that notes that a callout happened. */
1135 if (routed != NULL) *routed = TRUE;
1138 host_item *host_list = addr->host_list;
1140 /* Make up some data for use in the case where there is no remote
1143 transport_feedback tf = {
1144 NULL, /* interface (=> any) */
1145 US"smtp", /* port */
1146 US"smtp", /* protocol */
1148 US"$smtp_active_hostname", /* helo_data */
1149 FALSE, /* hosts_override */
1150 FALSE, /* hosts_randomize */
1151 FALSE, /* gethostbyname */
1152 TRUE, /* qualify_single */
1153 FALSE /* search_parents */
1156 /* If verification yielded a remote transport, we want to use that
1157 transport's options, so as to mimic what would happen if we were really
1158 sending a message to this address. */
1160 if (addr->transport != NULL && !addr->transport->info->local)
1162 (void)(addr->transport->setup)(addr->transport, addr, &tf, 0, 0, NULL);
1164 /* If the transport has hosts and the router does not, or if the
1165 transport is configured to override the router's hosts, we must build a
1166 host list of the transport's hosts, and find the IP addresses */
1168 if (tf.hosts != NULL && (host_list == NULL || tf.hosts_override))
1171 uschar *save_deliver_domain = deliver_domain;
1172 uschar *save_deliver_localpart = deliver_localpart;
1174 host_list = NULL; /* Ignore the router's hosts */
1176 deliver_domain = addr->domain;
1177 deliver_localpart = addr->local_part;
1178 s = expand_string(tf.hosts);
1179 deliver_domain = save_deliver_domain;
1180 deliver_localpart = save_deliver_localpart;
1184 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand list of hosts "
1185 "\"%s\" in %s transport for callout: %s", tf.hosts,
1186 addr->transport->name, expand_string_message);
1191 uschar *canonical_name;
1192 host_item *host, *nexthost;
1193 host_build_hostlist(&host_list, s, tf.hosts_randomize);
1195 /* Just ignore failures to find a host address. If we don't manage
1196 to find any addresses, the callout will defer. Note that more than
1197 one address may be found for a single host, which will result in
1198 additional host items being inserted into the chain. Hence we must
1199 save the next host first. */
1201 flags = HOST_FIND_BY_A;
1202 if (tf.qualify_single) flags |= HOST_FIND_QUALIFY_SINGLE;
1203 if (tf.search_parents) flags |= HOST_FIND_SEARCH_PARENTS;
1205 for (host = host_list; host != NULL; host = nexthost)
1207 nexthost = host->next;
1208 if (tf.gethostbyname ||
1209 string_is_ip_address(host->name, NULL) != 0)
1210 (void)host_find_byname(host, NULL, flags, &canonical_name, TRUE);
1212 (void)host_find_bydns(host, NULL, flags, NULL, NULL, NULL,
1213 &canonical_name, NULL);
1219 /* Can only do a callout if we have at least one host! If the callout
1220 fails, it will have set ${sender,recipient}_verify_failure. */
1222 if (host_list != NULL)
1224 HDEBUG(D_verify) debug_printf("Attempting full verification using callout\n");
1225 if (host_checking && !host_checking_callout)
1228 debug_printf("... callout omitted by default when host testing\n"
1229 "(Use -bhc if you want the callouts to happen.)\n");
1233 rc = do_callout(addr, host_list, &tf, callout, callout_overall,
1234 callout_connect, options, se_mailfrom, pm_mailfrom);
1239 HDEBUG(D_verify) debug_printf("Cannot do callout: neither router nor "
1240 "transport provided a host list\n");
1245 /* Otherwise, any failure is a routing failure */
1247 else *failure_ptr = US"route";
1249 /* A router may return REROUTED if it has set up a child address as a result
1250 of a change of domain name (typically from widening). In this case we always
1251 want to continue to verify the new child. */
1253 if (rc == REROUTED) continue;
1255 /* Handle hard failures */
1262 address_item *p = addr->parent;
1264 respond_printf(f, "%s%s %s", ko_prefix,
1265 full_info? addr->address : address,
1266 address_test_mode? "is undeliverable" : "failed to verify");
1267 if (!expn && admin_user)
1269 if (addr->basic_errno > 0)
1270 respond_printf(f, ": %s", strerror(addr->basic_errno));
1271 if (addr->message != NULL)
1272 respond_printf(f, ": %s", addr->message);
1275 /* Show parents iff doing full info */
1277 if (full_info) while (p != NULL)
1279 respond_printf(f, "%s\n <-- %s", cr, p->address);
1282 respond_printf(f, "%s\n", cr);
1285 if (!full_info) return copy_error(vaddr, addr, FAIL);
1291 else if (rc == DEFER)
1296 address_item *p = addr->parent;
1297 respond_printf(f, "%s%s cannot be resolved at this time", ko_prefix,
1298 full_info? addr->address : address);
1299 if (!expn && admin_user)
1301 if (addr->basic_errno > 0)
1302 respond_printf(f, ": %s", strerror(addr->basic_errno));
1303 if (addr->message != NULL)
1304 respond_printf(f, ": %s", addr->message);
1305 else if (addr->basic_errno <= 0)
1306 respond_printf(f, ": unknown error");
1309 /* Show parents iff doing full info */
1311 if (full_info) while (p != NULL)
1313 respond_printf(f, "%s\n <-- %s", cr, p->address);
1316 respond_printf(f, "%s\n", cr);
1318 if (!full_info) return copy_error(vaddr, addr, DEFER);
1319 else if (yield == OK) yield = DEFER;
1322 /* If we are handling EXPN, we do not want to continue to route beyond
1323 the top level (whose address is in "address"). */
1327 uschar *ok_prefix = US"250-";
1328 if (addr_new == NULL)
1330 if (addr_local == NULL && addr_remote == NULL)
1331 respond_printf(f, "250 mail to <%s> is discarded\r\n", address);
1333 respond_printf(f, "250 <%s>\r\n", address);
1335 else while (addr_new != NULL)
1337 address_item *addr2 = addr_new;
1338 addr_new = addr2->next;
1339 if (addr_new == NULL) ok_prefix = US"250 ";
1340 respond_printf(f, "%s<%s>\r\n", ok_prefix, addr2->address);
1345 /* Successful routing other than EXPN. */
1349 /* Handle successful routing when short info wanted. Otherwise continue for
1350 other (generated) addresses. Short info is the operational case. Full info
1351 can be requested only when debug_selector != 0 and a file is supplied.
1353 There is a conflict between the use of aliasing as an alternate email
1354 address, and as a sort of mailing list. If an alias turns the incoming
1355 address into just one address (e.g. J.Caesar->jc44) you may well want to
1356 carry on verifying the generated address to ensure it is valid when
1357 checking incoming mail. If aliasing generates multiple addresses, you
1358 probably don't want to do this. Exim therefore treats the generation of
1359 just a single new address as a special case, and continues on to verify the
1360 generated address. */
1362 if (!full_info && /* Stop if short info wanted AND */
1363 (((addr_new == NULL || /* No new address OR */
1364 addr_new->next != NULL || /* More than one new address OR */
1365 testflag(addr_new, af_pfr))) /* New address is pfr */
1367 (addr_new != NULL && /* At least one new address AND */
1368 success_on_redirect))) /* success_on_redirect is set */
1370 if (f != NULL) fprintf(f, "%s %s\n", address,
1371 address_test_mode? "is deliverable" : "verified");
1373 /* If we have carried on to verify a child address, we want the value
1374 of $address_data to be that of the child */
1376 vaddr->p.address_data = addr->p.address_data;
1380 } /* Loop for generated addresses */
1382 /* Display the full results of the successful routing, including any generated
1383 addresses. Control gets here only when full_info is set, which requires f not
1384 to be NULL, and this occurs only when a top-level verify is called with the
1385 debugging switch on.
1387 If there are no local and no remote addresses, and there were no pipes, files,
1388 or autoreplies, and there were no errors or deferments, the message is to be
1389 discarded, usually because of the use of :blackhole: in an alias file. */
1391 if (allok && addr_local == NULL && addr_remote == NULL)
1393 fprintf(f, "mail to %s is discarded\n", address);
1397 for (addr_list = addr_local, i = 0; i < 2; addr_list = addr_remote, i++)
1399 while (addr_list != NULL)
1401 address_item *addr = addr_list;
1402 address_item *p = addr->parent;
1403 addr_list = addr->next;
1405 fprintf(f, "%s", CS addr->address);
1406 #ifdef EXPERIMENTAL_SRS
1407 if(addr->p.srs_sender)
1408 fprintf(f, " [srs = %s]", addr->p.srs_sender);
1411 /* If the address is a duplicate, show something about it. */
1413 if (!testflag(addr, af_pfr))
1416 if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
1417 fprintf(f, " [duplicate, would not be delivered]");
1418 else tree_add_duplicate(addr->unique, addr);
1421 /* Now show its parents */
1425 fprintf(f, "\n <-- %s", p->address);
1430 /* Show router, and transport */
1432 fprintf(f, "router = %s, ", addr->router->name);
1433 fprintf(f, "transport = %s\n", (addr->transport == NULL)? US"unset" :
1434 addr->transport->name);
1436 /* Show any hosts that are set up by a router unless the transport
1437 is going to override them; fiddle a bit to get a nice format. */
1439 if (addr->host_list != NULL && addr->transport != NULL &&
1440 !addr->transport->overrides_hosts)
1445 for (h = addr->host_list; h != NULL; h = h->next)
1447 int len = Ustrlen(h->name);
1448 if (len > maxlen) maxlen = len;
1449 len = (h->address != NULL)? Ustrlen(h->address) : 7;
1450 if (len > maxaddlen) maxaddlen = len;
1452 for (h = addr->host_list; h != NULL; h = h->next)
1454 int len = Ustrlen(h->name);
1455 fprintf(f, " host %s ", h->name);
1456 while (len++ < maxlen) fprintf(f, " ");
1457 if (h->address != NULL)
1459 fprintf(f, "[%s] ", h->address);
1460 len = Ustrlen(h->address);
1462 else if (!addr->transport->info->local) /* Omit [unknown] for local */
1464 fprintf(f, "[unknown] ");
1468 while (len++ < maxaddlen) fprintf(f," ");
1469 if (h->mx >= 0) fprintf(f, "MX=%d", h->mx);
1470 if (h->port != PORT_NONE) fprintf(f, " port=%d", h->port);
1471 if (h->status == hstatus_unusable) fprintf(f, " ** unusable **");
1478 /* Will be DEFER or FAIL if any one address has, only for full_info (which is
1479 the -bv or -bt case). */
1487 /*************************************************
1488 * Check headers for syntax errors *
1489 *************************************************/
1491 /* This function checks those header lines that contain addresses, and verifies
1492 that all the addresses therein are syntactially correct.
1495 msgptr where to put an error message
1502 verify_check_headers(uschar **msgptr)
1508 for (h = header_list; h != NULL && yield == OK; h = h->next)
1510 if (h->type != htype_from &&
1511 h->type != htype_reply_to &&
1512 h->type != htype_sender &&
1513 h->type != htype_to &&
1514 h->type != htype_cc &&
1515 h->type != htype_bcc)
1518 colon = Ustrchr(h->text, ':');
1520 while (isspace(*s)) s++;
1522 /* Loop for multiple addresses in the header, enabling group syntax. Note
1523 that we have to reset this after the header has been scanned. */
1525 parse_allow_group = TRUE;
1529 uschar *ss = parse_find_address_end(s, FALSE);
1530 uschar *recipient, *errmess;
1531 int terminator = *ss;
1532 int start, end, domain;
1534 /* Temporarily terminate the string at this point, and extract the
1535 operative address within, allowing group syntax. */
1538 recipient = parse_extract_address(s,&errmess,&start,&end,&domain,FALSE);
1541 /* Permit an unqualified address only if the message is local, or if the
1542 sending host is configured to be permitted to send them. */
1544 if (recipient != NULL && domain == 0)
1546 if (h->type == htype_from || h->type == htype_sender)
1548 if (!allow_unqualified_sender) recipient = NULL;
1552 if (!allow_unqualified_recipient) recipient = NULL;
1554 if (recipient == NULL) errmess = US"unqualified address not permitted";
1557 /* It's an error if no address could be extracted, except for the special
1558 case of an empty address. */
1560 if (recipient == NULL && Ustrcmp(errmess, "empty address") != 0)
1562 uschar *verb = US"is";
1567 /* Arrange not to include any white space at the end in the
1568 error message or the header name. */
1570 while (t > s && isspace(t[-1])) t--;
1571 while (tt > h->text && isspace(tt[-1])) tt--;
1573 /* Add the address that failed to the error message, since in a
1574 header with very many addresses it is sometimes hard to spot
1575 which one is at fault. However, limit the amount of address to
1576 quote - cases have been seen where, for example, a missing double
1577 quote in a humungous To: header creates an "address" that is longer
1578 than string_sprintf can handle. */
1587 *msgptr = string_printing(
1588 string_sprintf("%s: failing address in \"%.*s:\" header %s: %.*s",
1589 errmess, tt - h->text, h->text, verb, len, s));
1592 break; /* Out of address loop */
1595 /* Advance to the next address */
1597 s = ss + (terminator? 1:0);
1598 while (isspace(*s)) s++;
1599 } /* Next address */
1601 parse_allow_group = FALSE;
1602 parse_found_group = FALSE;
1603 } /* Next header unless yield has been set FALSE */
1610 /*************************************************
1611 * Check for blind recipients *
1612 *************************************************/
1614 /* This function checks that every (envelope) recipient is mentioned in either
1615 the To: or Cc: header lines, thus detecting blind carbon copies.
1617 There are two ways of scanning that could be used: either scan the header lines
1618 and tick off the recipients, or scan the recipients and check the header lines.
1619 The original proposed patch did the former, but I have chosen to do the latter,
1620 because (a) it requires no memory and (b) will use fewer resources when there
1621 are many addresses in To: and/or Cc: and only one or two envelope recipients.
1624 Returns: OK if there are no blind recipients
1625 FAIL if there is at least one blind recipient
1629 verify_check_notblind(void)
1632 for (i = 0; i < recipients_count; i++)
1636 uschar *address = recipients_list[i].address;
1638 for (h = header_list; !found && h != NULL; h = h->next)
1642 if (h->type != htype_to && h->type != htype_cc) continue;
1644 colon = Ustrchr(h->text, ':');
1646 while (isspace(*s)) s++;
1648 /* Loop for multiple addresses in the header, enabling group syntax. Note
1649 that we have to reset this after the header has been scanned. */
1651 parse_allow_group = TRUE;
1655 uschar *ss = parse_find_address_end(s, FALSE);
1656 uschar *recipient,*errmess;
1657 int terminator = *ss;
1658 int start, end, domain;
1660 /* Temporarily terminate the string at this point, and extract the
1661 operative address within, allowing group syntax. */
1664 recipient = parse_extract_address(s,&errmess,&start,&end,&domain,FALSE);
1667 /* If we found a valid recipient that has a domain, compare it with the
1668 envelope recipient. Local parts are compared case-sensitively, domains
1669 case-insensitively. By comparing from the start with length "domain", we
1670 include the "@" at the end, which ensures that we are comparing the whole
1671 local part of each address. */
1673 if (recipient != NULL && domain != 0)
1675 found = Ustrncmp(recipient, address, domain) == 0 &&
1676 strcmpic(recipient + domain, address + domain) == 0;
1680 /* Advance to the next address */
1682 s = ss + (terminator? 1:0);
1683 while (isspace(*s)) s++;
1684 } /* Next address */
1686 parse_allow_group = FALSE;
1687 parse_found_group = FALSE;
1688 } /* Next header (if found is false) */
1690 if (!found) return FAIL;
1691 } /* Next recipient */
1698 /*************************************************
1699 * Find if verified sender *
1700 *************************************************/
1702 /* Usually, just a single address is verified as the sender of the message.
1703 However, Exim can be made to verify other addresses as well (often related in
1704 some way), and this is useful in some environments. There may therefore be a
1705 chain of such addresses that have previously been tested. This function finds
1706 whether a given address is on the chain.
1708 Arguments: the address to be verified
1709 Returns: pointer to an address item, or NULL
1713 verify_checked_sender(uschar *sender)
1716 for (addr = sender_verified_list; addr != NULL; addr = addr->next)
1717 if (Ustrcmp(sender, addr->address) == 0) break;
1725 /*************************************************
1726 * Get valid header address *
1727 *************************************************/
1729 /* Scan the originator headers of the message, looking for an address that
1730 verifies successfully. RFC 822 says:
1732 o The "Sender" field mailbox should be sent notices of
1733 any problems in transport or delivery of the original
1734 messages. If there is no "Sender" field, then the
1735 "From" field mailbox should be used.
1737 o If the "Reply-To" field exists, then the reply should
1738 go to the addresses indicated in that field and not to
1739 the address(es) indicated in the "From" field.
1741 So we check a Sender field if there is one, else a Reply_to field, else a From
1742 field. As some strange messages may have more than one of these fields,
1743 especially if they are resent- fields, check all of them if there is more than
1747 user_msgptr points to where to put a user error message
1748 log_msgptr points to where to put a log error message
1749 callout timeout for callout check (passed to verify_address())
1750 callout_overall overall callout timeout (ditto)
1751 callout_connect connect callout timeout (ditto)
1752 se_mailfrom mailfrom for verify; NULL => ""
1753 pm_mailfrom sender for pm callout check (passed to verify_address())
1754 options callout options (passed to verify_address())
1755 verrno where to put the address basic_errno
1757 If log_msgptr is set to something without setting user_msgptr, the caller
1758 normally uses log_msgptr for both things.
1760 Returns: result of the verification attempt: OK, FAIL, or DEFER;
1761 FAIL is given if no appropriate headers are found
1765 verify_check_header_address(uschar **user_msgptr, uschar **log_msgptr,
1766 int callout, int callout_overall, int callout_connect, uschar *se_mailfrom,
1767 uschar *pm_mailfrom, int options, int *verrno)
1769 static int header_types[] = { htype_sender, htype_reply_to, htype_from };
1774 for (i = 0; i < 3 && !done; i++)
1777 for (h = header_list; h != NULL && !done; h = h->next)
1779 int terminator, new_ok;
1780 uschar *s, *ss, *endname;
1782 if (h->type != header_types[i]) continue;
1783 s = endname = Ustrchr(h->text, ':') + 1;
1785 /* Scan the addresses in the header, enabling group syntax. Note that we
1786 have to reset this after the header has been scanned. */
1788 parse_allow_group = TRUE;
1792 address_item *vaddr;
1794 while (isspace(*s) || *s == ',') s++;
1795 if (*s == 0) break; /* End of header */
1797 ss = parse_find_address_end(s, FALSE);
1799 /* The terminator is a comma or end of header, but there may be white
1800 space preceding it (including newline for the last address). Move back
1801 past any white space so we can check against any cached envelope sender
1802 address verifications. */
1804 while (isspace(ss[-1])) ss--;
1808 HDEBUG(D_verify) debug_printf("verifying %.*s header address %s\n",
1809 (int)(endname - h->text), h->text, s);
1811 /* See if we have already verified this address as an envelope sender,
1812 and if so, use the previous answer. */
1814 vaddr = verify_checked_sender(s);
1816 if (vaddr != NULL && /* Previously checked */
1817 (callout <= 0 || /* No callout needed; OR */
1818 vaddr->special_action > 256)) /* Callout was done */
1820 new_ok = vaddr->special_action & 255;
1821 HDEBUG(D_verify) debug_printf("previously checked as envelope sender\n");
1822 *ss = terminator; /* Restore shortened string */
1825 /* Otherwise we run the verification now. We must restore the shortened
1826 string before running the verification, so the headers are correct, in
1827 case there is any rewriting. */
1831 int start, end, domain;
1832 uschar *address = parse_extract_address(s, log_msgptr, &start, &end,
1837 /* If we found an empty address, just carry on with the next one, but
1838 kill the message. */
1840 if (address == NULL && Ustrcmp(*log_msgptr, "empty address") == 0)
1847 /* If verification failed because of a syntax error, fail this
1848 function, and ensure that the failing address gets added to the error
1851 if (address == NULL)
1854 while (ss > s && isspace(ss[-1])) ss--;
1855 *log_msgptr = string_sprintf("syntax error in '%.*s' header when "
1856 "scanning for sender: %s in \"%.*s\"",
1857 endname - h->text, h->text, *log_msgptr, ss - s, s);
1863 /* Else go ahead with the sender verification. But it isn't *the*
1864 sender of the message, so set vopt_fake_sender to stop sender_address
1865 being replaced after rewriting or qualification. */
1869 vaddr = deliver_make_addr(address, FALSE);
1870 new_ok = verify_address(vaddr, NULL, options | vopt_fake_sender,
1871 callout, callout_overall, callout_connect, se_mailfrom,
1876 /* We now have the result, either newly found, or cached. If we are
1877 giving out error details, set a specific user error. This means that the
1878 last of these will be returned to the user if all three fail. We do not
1879 set a log message - the generic one below will be used. */
1883 *verrno = vaddr->basic_errno;
1884 if (smtp_return_error_details)
1886 *user_msgptr = string_sprintf("Rejected after DATA: "
1887 "could not verify \"%.*s\" header address\n%s: %s",
1888 endname - h->text, h->text, vaddr->address, vaddr->message);
1892 /* Success or defer */
1901 if (new_ok == DEFER) yield = DEFER;
1903 /* Move on to any more addresses in the header */
1906 } /* Next address */
1908 parse_allow_group = FALSE;
1909 parse_found_group = FALSE;
1910 } /* Next header, unless done */
1911 } /* Next header type unless done */
1913 if (yield == FAIL && *log_msgptr == NULL)
1914 *log_msgptr = US"there is no valid sender in any header line";
1916 if (yield == DEFER && *log_msgptr == NULL)
1917 *log_msgptr = US"all attempts to verify a sender in a header line deferred";
1925 /*************************************************
1926 * Get RFC 1413 identification *
1927 *************************************************/
1929 /* Attempt to get an id from the sending machine via the RFC 1413 protocol. If
1930 the timeout is set to zero, then the query is not done. There may also be lists
1931 of hosts and nets which are exempt. To guard against malefactors sending
1932 non-printing characters which could, for example, disrupt a message's headers,
1933 make sure the string consists of printing characters only.
1936 port the port to connect to; usually this is IDENT_PORT (113), but when
1937 running in the test harness with -bh a different value is used.
1941 Side effect: any received ident value is put in sender_ident (NULL otherwise)
1945 verify_get_ident(int port)
1947 int sock, host_af, qlen;
1948 int received_sender_port, received_interface_port, n;
1950 uschar buffer[2048];
1952 /* Default is no ident. Check whether we want to do an ident check for this
1955 sender_ident = NULL;
1956 if (rfc1413_query_timeout <= 0 || verify_check_host(&rfc1413_hosts) != OK)
1959 DEBUG(D_ident) debug_printf("doing ident callback\n");
1961 /* Set up a connection to the ident port of the remote host. Bind the local end
1962 to the incoming interface address. If the sender host address is an IPv6
1963 address, the incoming interface address will also be IPv6. */
1965 host_af = (Ustrchr(sender_host_address, ':') == NULL)? AF_INET : AF_INET6;
1966 sock = ip_socket(SOCK_STREAM, host_af);
1967 if (sock < 0) return;
1969 if (ip_bind(sock, host_af, interface_address, 0) < 0)
1971 DEBUG(D_ident) debug_printf("bind socket for ident failed: %s\n",
1976 if (ip_connect(sock, host_af, sender_host_address, port, rfc1413_query_timeout)
1979 if (errno == ETIMEDOUT && (log_extra_selector & LX_ident_timeout) != 0)
1981 log_write(0, LOG_MAIN, "ident connection to %s timed out",
1982 sender_host_address);
1986 DEBUG(D_ident) debug_printf("ident connection to %s failed: %s\n",
1987 sender_host_address, strerror(errno));
1992 /* Construct and send the query. */
1994 sprintf(CS buffer, "%d , %d\r\n", sender_host_port, interface_port);
1995 qlen = Ustrlen(buffer);
1996 if (send(sock, buffer, qlen, 0) < 0)
1998 DEBUG(D_ident) debug_printf("ident send failed: %s\n", strerror(errno));
2002 /* Read a response line. We put it into the rest of the buffer, using several
2003 recv() calls if necessary. */
2011 int size = sizeof(buffer) - (p - buffer);
2013 if (size <= 0) goto END_OFF; /* Buffer filled without seeing \n. */
2014 count = ip_recv(sock, p, size, rfc1413_query_timeout);
2015 if (count <= 0) goto END_OFF; /* Read error or EOF */
2017 /* Scan what we just read, to see if we have reached the terminating \r\n. Be
2018 generous, and accept a plain \n terminator as well. The only illegal
2021 for (pp = p; pp < p + count; pp++)
2023 if (*pp == 0) goto END_OFF; /* Zero octet not allowed */
2026 if (pp[-1] == '\r') pp--;
2028 goto GOT_DATA; /* Break out of both loops */
2032 /* Reached the end of the data without finding \n. Let the loop continue to
2033 read some more, if there is room. */
2040 /* We have received a line of data. Check it carefully. It must start with the
2041 same two port numbers that we sent, followed by data as defined by the RFC. For
2044 12345 , 25 : USERID : UNIX :root
2046 However, the amount of white space may be different to what we sent. In the
2047 "osname" field there may be several sub-fields, comma separated. The data we
2048 actually want to save follows the third colon. Some systems put leading spaces
2049 in it - we discard those. */
2051 if (sscanf(CS buffer + qlen, "%d , %d%n", &received_sender_port,
2052 &received_interface_port, &n) != 2 ||
2053 received_sender_port != sender_host_port ||
2054 received_interface_port != interface_port)
2057 p = buffer + qlen + n;
2058 while(isspace(*p)) p++;
2059 if (*p++ != ':') goto END_OFF;
2060 while(isspace(*p)) p++;
2061 if (Ustrncmp(p, "USERID", 6) != 0) goto END_OFF;
2063 while(isspace(*p)) p++;
2064 if (*p++ != ':') goto END_OFF;
2065 while (*p != 0 && *p != ':') p++;
2066 if (*p++ == 0) goto END_OFF;
2067 while(isspace(*p)) p++;
2068 if (*p == 0) goto END_OFF;
2070 /* The rest of the line is the data we want. We turn it into printing
2071 characters when we save it, so that it cannot mess up the format of any logging
2072 or Received: lines into which it gets inserted. We keep a maximum of 127
2075 sender_ident = string_printing(string_copyn(p, 127));
2076 DEBUG(D_ident) debug_printf("sender_ident = %s\n", sender_ident);
2086 /*************************************************
2087 * Match host to a single host-list item *
2088 *************************************************/
2090 /* This function compares a host (name or address) against a single item
2091 from a host list. The host name gets looked up if it is needed and is not
2092 already known. The function is called from verify_check_this_host() via
2093 match_check_list(), which is why most of its arguments are in a single block.
2096 arg the argument block (see below)
2097 ss the host-list item
2098 valueptr where to pass back looked up data, or NULL
2099 error for error message when returning ERROR
2102 host_name (a) the host name, or
2103 (b) NULL, implying use sender_host_name and
2104 sender_host_aliases, looking them up if required, or
2105 (c) the empty string, meaning that only IP address matches
2107 host_address the host address
2108 host_ipv4 the IPv4 address taken from an IPv6 one
2112 DEFER lookup deferred
2113 ERROR (a) failed to find the host name or IP address, or
2114 (b) unknown lookup type specified, or
2115 (c) host name encountered when only IP addresses are
2120 check_host(void *arg, uschar *ss, uschar **valueptr, uschar **error)
2122 check_host_block *cb = (check_host_block *)arg;
2125 BOOL iplookup = FALSE;
2126 BOOL isquery = FALSE;
2127 BOOL isiponly = cb->host_name != NULL && cb->host_name[0] == 0;
2132 /* Optimize for the special case when the pattern is "*". */
2134 if (*ss == '*' && ss[1] == 0) return OK;
2136 /* If the pattern is empty, it matches only in the case when there is no host -
2137 this can occur in ACL checking for SMTP input using the -bs option. In this
2138 situation, the host address is the empty string. */
2140 if (cb->host_address[0] == 0) return (*ss == 0)? OK : FAIL;
2141 if (*ss == 0) return FAIL;
2143 /* If the pattern is precisely "@" then match against the primary host name,
2144 provided that host name matching is permitted; if it's "@[]" match against the
2145 local host's IP addresses. */
2151 if (isiponly) return ERROR;
2152 ss = primary_hostname;
2154 else if (Ustrcmp(ss, "@[]") == 0)
2156 ip_address_item *ip;
2157 for (ip = host_find_interfaces(); ip != NULL; ip = ip->next)
2158 if (Ustrcmp(ip->address, cb->host_address) == 0) return OK;
2163 /* If the pattern is an IP address, optionally followed by a bitmask count, do
2164 a (possibly masked) comparision with the current IP address. */
2166 if (string_is_ip_address(ss, &maskoffset) != 0)
2167 return (host_is_in_net(cb->host_address, ss, maskoffset)? OK : FAIL);
2169 /* The pattern is not an IP address. A common error that people make is to omit
2170 one component of an IPv4 address, either by accident, or believing that, for
2171 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,
2172 which it isn't. (Those applications that do accept 1.2.3 as an IP address
2173 interpret it as 1.2.0.3 because the final component becomes 16-bit - this is an
2174 ancient specification.) To aid in debugging these cases, we give a specific
2175 error if the pattern contains only digits and dots or contains a slash preceded
2176 only by digits and dots (a slash at the start indicates a file name and of
2177 course slashes may be present in lookups, but not preceded only by digits and
2180 for (t = ss; isdigit(*t) || *t == '.'; t++);
2181 if (*t == 0 || (*t == '/' && t != ss))
2183 *error = US"malformed IPv4 address or address mask";
2187 /* See if there is a semicolon in the pattern */
2189 semicolon = Ustrchr(ss, ';');
2191 /* If we are doing an IP address only match, then all lookups must be IP
2192 address lookups, even if there is no "net-". */
2196 iplookup = semicolon != NULL;
2199 /* Otherwise, if the item is of the form net[n]-lookup;<file|query> then it is
2200 a lookup on a masked IP network, in textual form. We obey this code even if we
2201 have already set iplookup, so as to skip over the "net-" prefix and to set the
2202 mask length. The net- stuff really only applies to single-key lookups where the
2203 key is implicit. For query-style lookups the key is specified in the query.
2204 From release 4.30, the use of net- for query style is no longer needed, but we
2205 retain it for backward compatibility. */
2207 if (Ustrncmp(ss, "net", 3) == 0 && semicolon != NULL)
2210 for (t = ss + 3; isdigit(*t); t++) mlen = mlen * 10 + *t - '0';
2211 if (mlen == 0 && t == ss+3) mlen = -1; /* No mask supplied */
2212 iplookup = (*t++ == '-');
2216 /* Do the IP address lookup if that is indeed what we have */
2224 uschar *filename, *key, *result;
2227 /* Find the search type */
2229 search_type = search_findtype(t, semicolon - t);
2231 if (search_type < 0) log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s",
2232 search_error_message);
2234 /* Adjust parameters for the type of lookup. For a query-style lookup, there
2235 is no file name, and the "key" is just the query. For query-style with a file
2236 name, we have to fish the file off the start of the query. For a single-key
2237 lookup, the key is the current IP address, masked appropriately, and
2238 reconverted to text form, with the mask appended. For IPv6 addresses, specify
2239 dot separators instead of colons, except when the lookup type is "iplsearch".
2242 if (mac_islookup(search_type, lookup_absfilequery))
2244 filename = semicolon + 1;
2246 while (*key != 0 && !isspace(*key)) key++;
2247 filename = string_copyn(filename, key - filename);
2248 while (isspace(*key)) key++;
2250 else if (mac_islookup(search_type, lookup_querystyle))
2253 key = semicolon + 1;
2255 else /* Single-key style */
2257 int sep = (Ustrcmp(lookup_list[search_type]->name, "iplsearch") == 0)?
2259 insize = host_aton(cb->host_address, incoming);
2260 host_mask(insize, incoming, mlen);
2261 (void)host_nmtoa(insize, incoming, mlen, buffer, sep);
2263 filename = semicolon + 1;
2266 /* Now do the actual lookup; note that there is no search_close() because
2267 of the caching arrangements. */
2269 handle = search_open(filename, search_type, 0, NULL, NULL);
2270 if (handle == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s",
2271 search_error_message);
2272 result = search_find(handle, filename, key, -1, NULL, 0, 0, NULL);
2273 if (valueptr != NULL) *valueptr = result;
2274 return (result != NULL)? OK : search_find_defer? DEFER: FAIL;
2277 /* The pattern is not an IP address or network reference of any kind. That is,
2278 it is a host name pattern. If this is an IP only match, there's an error in the
2283 *error = US"cannot match host name in match_ip list";
2287 /* Check the characters of the pattern to see if they comprise only letters,
2288 digits, full stops, and hyphens (the constituents of domain names). Allow
2289 underscores, as they are all too commonly found. Sigh. Also, if
2290 allow_utf8_domains is set, allow top-bit characters. */
2292 for (t = ss; *t != 0; t++)
2293 if (!isalnum(*t) && *t != '.' && *t != '-' && *t != '_' &&
2294 (!allow_utf8_domains || *t < 128)) break;
2296 /* If the pattern is a complete domain name, with no fancy characters, look up
2297 its IP address and match against that. Note that a multi-homed host will add
2298 items to the chain. */
2309 rc = host_find_byname(&h, NULL, HOST_FIND_QUALIFY_SINGLE, NULL, FALSE);
2310 if (rc == HOST_FOUND || rc == HOST_FOUND_LOCAL)
2313 for (hh = &h; hh != NULL; hh = hh->next)
2315 if (host_is_in_net(hh->address, cb->host_address, 0)) return OK;
2319 if (rc == HOST_FIND_AGAIN) return DEFER;
2320 *error = string_sprintf("failed to find IP address for %s", ss);
2324 /* Almost all subsequent comparisons require the host name, and can be done
2325 using the general string matching function. When this function is called for
2326 outgoing hosts, the name is always given explicitly. If it is NULL, it means we
2327 must use sender_host_name and its aliases, looking them up if necessary. */
2329 if (cb->host_name != NULL) /* Explicit host name given */
2330 return match_check_string(cb->host_name, ss, -1, TRUE, TRUE, TRUE,
2333 /* Host name not given; in principle we need the sender host name and its
2334 aliases. However, for query-style lookups, we do not need the name if the
2335 query does not contain $sender_host_name. From release 4.23, a reference to
2336 $sender_host_name causes it to be looked up, so we don't need to do the lookup
2339 if ((semicolon = Ustrchr(ss, ';')) != NULL)
2342 int partial, affixlen, starflags, id;
2345 id = search_findtype_partial(ss, &partial, &affix, &affixlen, &starflags);
2348 if (id < 0) /* Unknown lookup type */
2350 log_write(0, LOG_MAIN|LOG_PANIC, "%s in host list item \"%s\"",
2351 search_error_message, ss);
2354 isquery = mac_islookup(id, lookup_querystyle|lookup_absfilequery);
2359 switch(match_check_string(US"", ss, -1, TRUE, TRUE, TRUE, valueptr))
2362 case DEFER: return DEFER;
2363 default: return FAIL;
2367 /* Not a query-style lookup; must ensure the host name is present, and then we
2368 do a check on the name and all its aliases. */
2370 if (sender_host_name == NULL)
2372 HDEBUG(D_host_lookup)
2373 debug_printf("sender host name required, to match against %s\n", ss);
2374 if (host_lookup_failed || host_name_lookup() != OK)
2376 *error = string_sprintf("failed to find host name for %s",
2377 sender_host_address);;
2380 host_build_sender_fullhost();
2383 /* Match on the sender host name, using the general matching function */
2385 switch(match_check_string(sender_host_name, ss, -1, TRUE, TRUE, TRUE,
2389 case DEFER: return DEFER;
2392 /* If there are aliases, try matching on them. */
2394 aliases = sender_host_aliases;
2395 while (*aliases != NULL)
2397 switch(match_check_string(*aliases++, ss, -1, TRUE, TRUE, TRUE, valueptr))
2400 case DEFER: return DEFER;
2409 /*************************************************
2410 * Check a specific host matches a host list *
2411 *************************************************/
2413 /* This function is passed a host list containing items in a number of
2414 different formats and the identity of a host. Its job is to determine whether
2415 the given host is in the set of hosts defined by the list. The host name is
2416 passed as a pointer so that it can be looked up if needed and not already
2417 known. This is commonly the case when called from verify_check_host() to check
2418 an incoming connection. When called from elsewhere the host name should usually
2421 This function is now just a front end to match_check_list(), which runs common
2422 code for scanning a list. We pass it the check_host() function to perform a
2426 listptr pointer to the host list
2427 cache_bits pointer to cache for named lists, or NULL
2428 host_name the host name or NULL, implying use sender_host_name and
2429 sender_host_aliases, looking them up if required
2430 host_address the IP address
2431 valueptr if not NULL, data from a lookup is passed back here
2433 Returns: OK if the host is in the defined set
2434 FAIL if the host is not in the defined set,
2435 DEFER if a data lookup deferred (not a host lookup)
2437 If the host name was needed in order to make a comparison, and could not be
2438 determined from the IP address, the result is FAIL unless the item
2439 "+allow_unknown" was met earlier in the list, in which case OK is returned. */
2442 verify_check_this_host(uschar **listptr, unsigned int *cache_bits,
2443 uschar *host_name, uschar *host_address, uschar **valueptr)
2446 unsigned int *local_cache_bits = cache_bits;
2447 uschar *save_host_address = deliver_host_address;
2448 check_host_block cb;
2449 cb.host_name = host_name;
2450 cb.host_address = host_address;
2452 if (valueptr != NULL) *valueptr = NULL;
2454 /* If the host address starts off ::ffff: it is an IPv6 address in
2455 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2458 cb.host_ipv4 = (Ustrncmp(host_address, "::ffff:", 7) == 0)?
2459 host_address + 7 : host_address;
2461 /* During the running of the check, put the IP address into $host_address. In
2462 the case of calls from the smtp transport, it will already be there. However,
2463 in other calls (e.g. when testing ignore_target_hosts), it won't. Just to be on
2464 the safe side, any existing setting is preserved, though as I write this
2465 (November 2004) I can't see any cases where it is actually needed. */
2467 deliver_host_address = host_address;
2468 rc = match_check_list(
2469 listptr, /* the list */
2470 0, /* separator character */
2471 &hostlist_anchor, /* anchor pointer */
2472 &local_cache_bits, /* cache pointer */
2473 check_host, /* function for testing */
2474 &cb, /* argument for function */
2475 MCL_HOST, /* type of check */
2476 (host_address == sender_host_address)?
2477 US"host" : host_address, /* text for debugging */
2478 valueptr); /* where to pass back data */
2479 deliver_host_address = save_host_address;
2486 /*************************************************
2487 * Check the remote host matches a list *
2488 *************************************************/
2490 /* This is a front end to verify_check_this_host(), created because checking
2491 the remote host is a common occurrence. With luck, a good compiler will spot
2492 the tail recursion and optimize it. If there's no host address, this is
2493 command-line SMTP input - check against an empty string for the address.
2496 listptr pointer to the host list
2498 Returns: the yield of verify_check_this_host(),
2499 i.e. OK, FAIL, or DEFER
2503 verify_check_host(uschar **listptr)
2505 return verify_check_this_host(listptr, sender_host_cache, NULL,
2506 (sender_host_address == NULL)? US"" : sender_host_address, NULL);
2513 /*************************************************
2514 * Invert an IP address *
2515 *************************************************/
2517 /* Originally just used for DNS xBL lists, now also used for the
2518 reverse_ip expansion operator.
2521 buffer where to put the answer
2522 address the address to invert
2526 invert_address(uschar *buffer, uschar *address)
2529 uschar *bptr = buffer;
2531 /* If this is an IPv4 address mapped into IPv6 format, adjust the pointer
2532 to the IPv4 part only. */
2534 if (Ustrncmp(address, "::ffff:", 7) == 0) address += 7;
2536 /* Handle IPv4 address: when HAVE_IPV6 is false, the result of host_aton() is
2539 if (host_aton(address, bin) == 1)
2543 for (i = 0; i < 4; i++)
2545 sprintf(CS bptr, "%d.", x & 255);
2546 while (*bptr) bptr++;
2551 /* Handle IPv6 address. Actually, as far as I know, there are no IPv6 addresses
2552 in any DNS black lists, and the format in which they will be looked up is
2553 unknown. This is just a guess. */
2559 for (j = 3; j >= 0; j--)
2562 for (i = 0; i < 8; i++)
2564 sprintf(CS bptr, "%x.", x & 15);
2565 while (*bptr) bptr++;
2572 /* Remove trailing period -- this is needed so that both arbitrary
2573 dnsbl keydomains and inverted addresses may be combined with the
2574 same format string, "%s.%s" */
2581 /*************************************************
2582 * Perform a single dnsbl lookup *
2583 *************************************************/
2585 /* This function is called from verify_check_dnsbl() below. It is also called
2586 recursively from within itself when domain and domain_txt are different
2587 pointers, in order to get the TXT record from the alternate domain.
2590 domain the outer dnsbl domain
2591 domain_txt alternate domain to lookup TXT record on success; when the
2592 same domain is to be used, domain_txt == domain (that is,
2593 the pointers must be identical, not just the text)
2594 keydomain the current keydomain (for debug message)
2595 prepend subdomain to lookup (like keydomain, but
2596 reversed if IP address)
2597 iplist the list of matching IP addresses, or NULL for "any"
2598 bitmask true if bitmask matching is wanted
2599 match_type condition for 'succeed' result
2600 0 => Any RR in iplist (=)
2601 1 => No RR in iplist (!=)
2602 2 => All RRs in iplist (==)
2603 3 => Some RRs not in iplist (!==)
2604 the two bits are defined as MT_NOT and MT_ALL
2605 defer_return what to return for a defer
2607 Returns: OK if lookup succeeded
2612 one_check_dnsbl(uschar *domain, uschar *domain_txt, uschar *keydomain,
2613 uschar *prepend, uschar *iplist, BOOL bitmask, int match_type,
2619 dnsbl_cache_block *cb;
2620 int old_pool = store_pool;
2621 uschar query[256]; /* DNS domain max length */
2623 /* Construct the specific query domainname */
2625 if (!string_format(query, sizeof(query), "%s.%s", prepend, domain))
2627 log_write(0, LOG_MAIN|LOG_PANIC, "dnslist query is too long "
2628 "(ignored): %s...", query);
2632 /* Look for this query in the cache. */
2634 t = tree_search(dnsbl_cache, query);
2636 /* If not cached from a previous lookup, we must do a DNS lookup, and
2637 cache the result in permanent memory. */
2641 store_pool = POOL_PERM;
2643 /* Set up a tree entry to cache the lookup */
2645 t = store_get(sizeof(tree_node) + Ustrlen(query));
2646 Ustrcpy(t->name, query);
2647 t->data.ptr = cb = store_get(sizeof(dnsbl_cache_block));
2648 (void)tree_insertnode(&dnsbl_cache, t);
2650 /* Do the DNS loopup . */
2652 HDEBUG(D_dnsbl) debug_printf("new DNS lookup for %s\n", query);
2653 cb->rc = dns_basic_lookup(&dnsa, query, T_A);
2654 cb->text_set = FALSE;
2658 /* If the lookup succeeded, cache the RHS address. The code allows for
2659 more than one address - this was for complete generality and the possible
2660 use of A6 records. However, A6 records have been reduced to experimental
2661 status (August 2001) and may die out. So they may never get used at all,
2662 let alone in dnsbl records. However, leave the code here, just in case.
2664 Quite apart from one A6 RR generating multiple addresses, there are DNS
2665 lists that return more than one A record, so we must handle multiple
2666 addresses generated in that way as well. */
2668 if (cb->rc == DNS_SUCCEED)
2671 dns_address **addrp = &(cb->rhs);
2672 for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
2674 rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
2676 if (rr->type == T_A)
2678 dns_address *da = dns_address_from_rr(&dnsa, rr);
2682 while (da->next != NULL) da = da->next;
2683 addrp = &(da->next);
2688 /* If we didn't find any A records, change the return code. This can
2689 happen when there is a CNAME record but there are no A records for what
2692 if (cb->rhs == NULL) cb->rc = DNS_NODATA;
2695 store_pool = old_pool;
2698 /* Previous lookup was cached */
2702 HDEBUG(D_dnsbl) debug_printf("using result of previous DNS lookup\n");
2706 /* We now have the result of the DNS lookup, either newly done, or cached
2707 from a previous call. If the lookup succeeded, check against the address
2708 list if there is one. This may be a positive equality list (introduced by
2709 "="), a negative equality list (introduced by "!="), a positive bitmask
2710 list (introduced by "&"), or a negative bitmask list (introduced by "!&").*/
2712 if (cb->rc == DNS_SUCCEED)
2714 dns_address *da = NULL;
2715 uschar *addlist = cb->rhs->address;
2717 /* For A and AAAA records, there may be multiple addresses from multiple
2718 records. For A6 records (currently not expected to be used) there may be
2719 multiple addresses from a single record. */
2721 for (da = cb->rhs->next; da != NULL; da = da->next)
2722 addlist = string_sprintf("%s, %s", addlist, da->address);
2724 HDEBUG(D_dnsbl) debug_printf("DNS lookup for %s succeeded (yielding %s)\n",
2727 /* Address list check; this can be either for equality, or via a bitmask.
2728 In the latter case, all the bits must match. */
2732 for (da = cb->rhs; da != NULL; da = da->next)
2736 uschar *ptr = iplist;
2739 /* Handle exact matching */
2743 while ((res = string_nextinlist(&ptr, &ipsep, ip, sizeof(ip))) != NULL)
2745 if (Ustrcmp(CS da->address, ip) == 0) break;
2749 /* Handle bitmask matching */
2756 /* At present, all known DNS blocking lists use A records, with
2757 IPv4 addresses on the RHS encoding the information they return. I
2758 wonder if this will linger on as the last vestige of IPv4 when IPv6
2759 is ubiquitous? Anyway, for now we use paranoia code to completely
2760 ignore IPv6 addresses. The default mask is 0, which always matches.
2761 We change this only for IPv4 addresses in the list. */
2763 if (host_aton(da->address, address) == 1) mask = address[0];
2765 /* Scan the returned addresses, skipping any that are IPv6 */
2767 while ((res = string_nextinlist(&ptr, &ipsep, ip, sizeof(ip))) != NULL)
2769 if (host_aton(ip, address) != 1) continue;
2770 if ((address[0] & mask) == address[0]) break;
2776 (a) An IP address in an any ('=') list matched, or
2777 (b) No IP address in an all ('==') list matched
2779 then we're done searching. */
2781 if (((match_type & MT_ALL) != 0) == (res == NULL)) break;
2784 /* If da == NULL, either
2786 (a) No IP address in an any ('=') list matched, or
2787 (b) An IP address in an all ('==') list didn't match
2789 so behave as if the DNSBL lookup had not succeeded, i.e. the host is not on
2792 if ((match_type == MT_NOT || match_type == MT_ALL) != (da == NULL))
2800 res = US"was no match";
2803 res = US"was an exclude match";
2806 res = US"was an IP address that did not match";
2809 res = US"were no IP addresses that did not match";
2812 debug_printf("=> but we are not accepting this block class because\n");
2813 debug_printf("=> there %s for %s%c%s\n",
2815 ((match_type & MT_ALL) == 0)? "" : "=",
2816 bitmask? '&' : '=', iplist);
2822 /* Either there was no IP list, or the record matched, implying that the
2823 domain is on the list. We now want to find a corresponding TXT record. If an
2824 alternate domain is specified for the TXT record, call this function
2825 recursively to look that up; this has the side effect of re-checking that
2826 there is indeed an A record at the alternate domain. */
2828 if (domain_txt != domain)
2829 return one_check_dnsbl(domain_txt, domain_txt, keydomain, prepend, NULL,
2830 FALSE, match_type, defer_return);
2832 /* If there is no alternate domain, look up a TXT record in the main domain
2833 if it has not previously been cached. */
2837 cb->text_set = TRUE;
2838 if (dns_basic_lookup(&dnsa, query, T_TXT) == DNS_SUCCEED)
2841 for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
2843 rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
2844 if (rr->type == T_TXT) break;
2847 int len = (rr->data)[0];
2848 if (len > 511) len = 127;
2849 store_pool = POOL_PERM;
2850 cb->text = string_sprintf("%.*s", len, (const uschar *)(rr->data+1));
2851 store_pool = old_pool;
2856 dnslist_value = addlist;
2857 dnslist_text = cb->text;
2861 /* There was a problem with the DNS lookup */
2863 if (cb->rc != DNS_NOMATCH && cb->rc != DNS_NODATA)
2865 log_write(L_dnslist_defer, LOG_MAIN,
2866 "DNS list lookup defer (probably timeout) for %s: %s", query,
2867 (defer_return == OK)? US"assumed in list" :
2868 (defer_return == FAIL)? US"assumed not in list" :
2869 US"returned DEFER");
2870 return defer_return;
2873 /* No entry was found in the DNS; continue for next domain */
2877 debug_printf("DNS lookup for %s failed\n", query);
2878 debug_printf("=> that means %s is not listed at %s\n",
2888 /*************************************************
2889 * Check host against DNS black lists *
2890 *************************************************/
2892 /* This function runs checks against a list of DNS black lists, until one
2893 matches. Each item on the list can be of the form
2895 domain=ip-address/key
2897 The domain is the right-most domain that is used for the query, for example,
2898 blackholes.mail-abuse.org. If the IP address is present, there is a match only
2899 if the DNS lookup returns a matching IP address. Several addresses may be
2900 given, comma-separated, for example: x.y.z=127.0.0.1,127.0.0.2.
2902 If no key is given, what is looked up in the domain is the inverted IP address
2903 of the current client host. If a key is given, it is used to construct the
2904 domain for the lookup. For example:
2906 dsn.rfc-ignorant.org/$sender_address_domain
2908 After finding a match in the DNS, the domain is placed in $dnslist_domain, and
2909 then we check for a TXT record for an error message, and if found, save its
2910 value in $dnslist_text. We also cache everything in a tree, to optimize
2913 The TXT record is normally looked up in the same domain as the A record, but
2914 when many lists are combined in a single DNS domain, this will not be a very
2915 specific message. It is possible to specify a different domain for looking up
2916 TXT records; this is given before the main domain, comma-separated. For
2919 dnslists = http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
2920 socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3
2922 The caching ensures that only one lookup in dnsbl.sorbs.net is done.
2924 Note: an address for testing RBL is 192.203.178.39
2925 Note: an address for testing DUL is 192.203.178.4
2926 Note: a domain for testing RFCI is example.tld.dsn.rfc-ignorant.org
2929 listptr the domain/address/data list
2931 Returns: OK successful lookup (i.e. the address is on the list), or
2932 lookup deferred after +include_unknown
2933 FAIL name not found, or no data found for the given type, or
2934 lookup deferred after +exclude_unknown (default)
2935 DEFER lookup failure, if +defer_unknown was set
2939 verify_check_dnsbl(uschar **listptr)
2942 int defer_return = FAIL;
2943 uschar *list = *listptr;
2946 uschar buffer[1024];
2947 uschar revadd[128]; /* Long enough for IPv6 address */
2949 /* Indicate that the inverted IP address is not yet set up */
2953 /* In case this is the first time the DNS resolver is being used. */
2955 dns_init(FALSE, FALSE);
2957 /* Loop through all the domains supplied, until something matches */
2959 while ((domain = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
2962 BOOL bitmask = FALSE;
2969 HDEBUG(D_dnsbl) debug_printf("DNS list check: %s\n", domain);
2971 /* Deal with special values that change the behaviour on defer */
2973 if (domain[0] == '+')
2975 if (strcmpic(domain, US"+include_unknown") == 0) defer_return = OK;
2976 else if (strcmpic(domain, US"+exclude_unknown") == 0) defer_return = FAIL;
2977 else if (strcmpic(domain, US"+defer_unknown") == 0) defer_return = DEFER;
2979 log_write(0, LOG_MAIN|LOG_PANIC, "unknown item in dnslist (ignored): %s",
2984 /* See if there's explicit data to be looked up */
2986 key = Ustrchr(domain, '/');
2987 if (key != NULL) *key++ = 0;
2989 /* See if there's a list of addresses supplied after the domain name. This is
2990 introduced by an = or a & character; if preceded by = we require all matches
2991 and if preceded by ! we invert the result. */
2993 iplist = Ustrchr(domain, '=');
2997 iplist = Ustrchr(domain, '&');
3000 if (iplist != NULL) /* Found either = or & */
3002 if (iplist > domain && iplist[-1] == '!') /* Handle preceding ! */
3004 match_type |= MT_NOT;
3008 *iplist++ = 0; /* Terminate domain, move on */
3010 /* If we found = (bitmask == FALSE), check for == or =& */
3012 if (!bitmask && (*iplist == '=' || *iplist == '&'))
3014 bitmask = *iplist++ == '&';
3015 match_type |= MT_ALL;
3019 /* If there is a comma in the domain, it indicates that a second domain for
3020 looking up TXT records is provided, before the main domain. Otherwise we must
3021 set domain_txt == domain. */
3023 domain_txt = domain;
3024 comma = Ustrchr(domain, ',');
3031 /* Check that what we have left is a sensible domain name. There is no reason
3032 why these domains should in fact use the same syntax as hosts and email
3033 domains, but in practice they seem to. However, there is little point in
3034 actually causing an error here, because that would no doubt hold up incoming
3035 mail. Instead, I'll just log it. */
3037 for (s = domain; *s != 0; s++)
3039 if (!isalnum(*s) && *s != '-' && *s != '.' && *s != '_')
3041 log_write(0, LOG_MAIN, "dnslists domain \"%s\" contains "
3042 "strange characters - is this right?", domain);
3047 /* Check the alternate domain if present */
3049 if (domain_txt != domain) for (s = domain_txt; *s != 0; s++)
3051 if (!isalnum(*s) && *s != '-' && *s != '.' && *s != '_')
3053 log_write(0, LOG_MAIN, "dnslists domain \"%s\" contains "
3054 "strange characters - is this right?", domain_txt);
3059 /* If there is no key string, construct the query by adding the domain name
3060 onto the inverted host address, and perform a single DNS lookup. */
3064 if (sender_host_address == NULL) return FAIL; /* can never match */
3065 if (revadd[0] == 0) invert_address(revadd, sender_host_address);
3066 rc = one_check_dnsbl(domain, domain_txt, sender_host_address, revadd,
3067 iplist, bitmask, match_type, defer_return);
3070 dnslist_domain = string_copy(domain_txt);
3071 dnslist_matched = string_copy(sender_host_address);
3072 HDEBUG(D_dnsbl) debug_printf("=> that means %s is listed at %s\n",
3073 sender_host_address, dnslist_domain);
3075 if (rc != FAIL) return rc; /* OK or DEFER */
3078 /* If there is a key string, it can be a list of domains or IP addresses to
3079 be concatenated with the main domain. */
3086 uschar keybuffer[256];
3087 uschar keyrevadd[128];
3089 while ((keydomain = string_nextinlist(&key, &keysep, keybuffer,
3090 sizeof(keybuffer))) != NULL)
3092 uschar *prepend = keydomain;
3094 if (string_is_ip_address(keydomain, NULL) != 0)
3096 invert_address(keyrevadd, keydomain);
3097 prepend = keyrevadd;
3100 rc = one_check_dnsbl(domain, domain_txt, keydomain, prepend, iplist,
3101 bitmask, match_type, defer_return);
3105 dnslist_domain = string_copy(domain_txt);
3106 dnslist_matched = string_copy(keydomain);
3107 HDEBUG(D_dnsbl) debug_printf("=> that means %s is listed at %s\n",
3108 keydomain, dnslist_domain);
3112 /* If the lookup deferred, remember this fact. We keep trying the rest
3113 of the list to see if we get a useful result, and if we don't, we return
3114 DEFER at the end. */
3116 if (rc == DEFER) defer = TRUE;
3117 } /* continue with next keystring domain/address */
3119 if (defer) return DEFER;
3121 } /* continue with next dnsdb outer domain */
3126 /* End of verify.c */