1 /* $Cambridge: exim/src/src/verify.c,v 1.1 2004/10/07 10:39:01 ph10 Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2004 */
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;
33 /*************************************************
34 * Retrieve a callout cache record *
35 *************************************************/
37 /* If a record exists, check whether it has expired.
40 dbm_file an open hints file
42 type "address" or "domain"
43 positive_expire expire time for positive records
44 negative_expire expire time for negative records
46 Returns: the cache record if a non-expired one exists, else NULL
49 static dbdata_callout_cache *
50 get_callout_cache_record(open_db *dbm_file, uschar *key, uschar *type,
51 int positive_expire, int negative_expire)
56 dbdata_callout_cache *cache_record;
58 cache_record = dbfn_read_with_length(dbm_file, key, &length);
60 if (cache_record == NULL)
62 HDEBUG(D_verify) debug_printf("callout cache: no %s record found\n", type);
66 /* We treat a record as "negative" if its result field is not positive, or if
67 it is a domain record and the postmaster field is negative. */
69 negative = cache_record->result != ccache_accept ||
70 (type[0] == 'd' && cache_record->postmaster_result == ccache_reject);
71 expire = negative? negative_expire : positive_expire;
74 if (now - cache_record->time_stamp > expire)
76 HDEBUG(D_verify) debug_printf("callout cache: %s record expired\n", type);
80 /* If this is a non-reject domain record, check for the obsolete format version
81 that doesn't have the postmaster and random timestamps, by looking at the
82 length. If so, copy it to a new-style block, replicating the record's
83 timestamp. Then check the additional timestamps. (There's no point wasting
84 effort if connections are rejected.) */
86 if (type[0] == 'd' && cache_record->result != ccache_reject)
88 if (length == sizeof(dbdata_callout_cache_obs))
90 dbdata_callout_cache *new = store_get(sizeof(dbdata_callout_cache));
91 memcpy(new, cache_record, length);
92 new->postmaster_stamp = new->random_stamp = new->time_stamp;
96 if (now - cache_record->postmaster_stamp > expire)
97 cache_record->postmaster_result = ccache_unknown;
99 if (now - cache_record->random_stamp > expire)
100 cache_record->random_result = ccache_unknown;
103 HDEBUG(D_verify) debug_printf("callout cache: found %s record\n", type);
109 /*************************************************
110 * Do callout verification for an address *
111 *************************************************/
113 /* This function is called from verify_address() when the address has routed to
114 a host list, and a callout has been requested. Callouts are expensive; that is
115 why a cache is used to improve the efficiency.
118 addr the address that's been routed
119 host_list the list of hosts to try
120 tf the transport feedback block
122 ifstring "interface" option from transport, or NULL
123 portstring "port" option from transport, or NULL
124 protocolstring "protocol" option from transport, or NULL
125 callout the per-command callout timeout
126 callout_overall the overall callout timeout (if < 0; use 4*callout)
127 options the verification options - these bits are used:
128 vopt_is_recipient => this is a recipient address
129 vopt_callout_no_cache => don't use callout cache
130 vopt_callout_random => do the "random" thing
131 vopt_callout_recipsender => use real sender for recipient
132 vopt_callout_recippmaster => use postmaster for recipient
133 se_mailfrom MAIL FROM address for sender verify; NULL => ""
134 pm_mailfrom if non-NULL, do the postmaster check with this sender
136 Returns: OK/FAIL/DEFER
140 do_callout(address_item *addr, host_item *host_list, transport_feedback *tf,
141 int callout, int callout_overall, int options, uschar *se_mailfrom,
144 BOOL is_recipient = (options & vopt_is_recipient) != 0;
145 BOOL callout_no_cache = (options & vopt_callout_no_cache) != 0;
146 BOOL callout_random = (options & vopt_callout_random) != 0;
151 uschar *from_address;
152 uschar *random_local_part = NULL;
154 open_db *dbm_file = NULL;
155 dbdata_callout_cache new_domain_record;
156 dbdata_callout_cache_address new_address_record;
158 time_t callout_start_time;
160 new_domain_record.result = ccache_unknown;
161 new_domain_record.postmaster_result = ccache_unknown;
162 new_domain_record.random_result = ccache_unknown;
164 memset(&new_address_record, 0, sizeof(new_address_record));
166 /* For a recipient callout, the key used for the address cache record must
167 include the sender address if we are using the real sender in the callout,
168 because that may influence the result of the callout. */
170 address_key = addr->address;
175 if ((options & vopt_callout_recipsender) != 0)
177 address_key = string_sprintf("%s/<%s>", addr->address, sender_address);
178 from_address = sender_address;
180 else if ((options & vopt_callout_recippmaster) != 0)
182 address_key = string_sprintf("%s/<postmaster@%s>", addr->address,
183 qualify_domain_sender);
184 from_address = string_sprintf("postmaster@%s", qualify_domain_sender);
188 /* For a sender callout, we must adjust the key if the mailfrom address is not
193 from_address = (se_mailfrom == NULL)? US"" : se_mailfrom;
194 if (from_address[0] != 0)
195 address_key = string_sprintf("%s/<%s>", addr->address, from_address);
198 /* Open the callout cache database, it it exists, for reading only at this
199 stage, unless caching has been disabled. */
201 if (callout_no_cache)
203 HDEBUG(D_verify) debug_printf("callout cache: disabled by no_cache\n");
205 else if ((dbm_file = dbfn_open(US"callout", O_RDWR, &dbblock, FALSE)) == NULL)
207 HDEBUG(D_verify) debug_printf("callout cache: not available\n");
210 /* If a cache database is available see if we can avoid the need to do an
211 actual callout by making use of previously-obtained data. */
213 if (dbm_file != NULL)
215 dbdata_callout_cache_address *cache_address_record;
216 dbdata_callout_cache *cache_record = get_callout_cache_record(dbm_file,
217 addr->domain, US"domain",
218 callout_cache_domain_positive_expire,
219 callout_cache_domain_negative_expire);
221 /* If an unexpired cache record was found for this domain, see if the callout
222 process can be short-circuited. */
224 if (cache_record != NULL)
226 /* If an early command (up to and including MAIL FROM:<>) was rejected,
227 there is no point carrying on. The callout fails. */
229 if (cache_record->result == ccache_reject)
231 setflag(addr, af_verify_nsfail);
233 debug_printf("callout cache: domain gave initial rejection, or "
234 "does not accept HELO or MAIL FROM:<>\n");
235 setflag(addr, af_verify_nsfail);
236 addr->user_message = US"(result of an earlier callout reused).";
241 /* If a previous check on a "random" local part was accepted, we assume
242 that the server does not do any checking on local parts. There is therefore
243 no point in doing the callout, because it will always be successful. If a
244 random check previously failed, arrange not to do it again, but preserve
245 the data in the new record. If a random check is required but hasn't been
246 done, skip the remaining cache processing. */
248 if (callout_random) switch(cache_record->random_result)
252 debug_printf("callout cache: domain accepts random addresses\n");
253 goto END_CALLOUT; /* Default yield is OK */
257 debug_printf("callout cache: domain rejects random addresses\n");
258 callout_random = FALSE;
259 new_domain_record.random_result = ccache_reject;
260 new_domain_record.random_stamp = cache_record->random_stamp;
265 debug_printf("callout cache: need to check random address handling "
266 "(not cached or cache expired)\n");
270 /* If a postmaster check is requested, but there was a previous failure,
271 there is again no point in carrying on. If a postmaster check is required,
272 but has not been done before, we are going to have to do a callout, so skip
273 remaining cache processing. */
275 if (pm_mailfrom != NULL)
277 if (cache_record->postmaster_result == ccache_reject)
279 setflag(addr, af_verify_pmfail);
281 debug_printf("callout cache: domain does not accept "
282 "RCPT TO:<postmaster@domain>\n");
284 setflag(addr, af_verify_pmfail);
285 addr->user_message = US"(result of earlier verification reused).";
288 if (cache_record->postmaster_result == ccache_unknown)
291 debug_printf("callout cache: need to check RCPT "
292 "TO:<postmaster@domain> (not cached or cache expired)\n");
296 /* If cache says OK, set pm_mailfrom NULL to prevent a redundant
297 postmaster check if the address itself has to be checked. Also ensure
298 that the value in the cache record is preserved (with its old timestamp).
301 HDEBUG(D_verify) debug_printf("callout cache: domain accepts RCPT "
302 "TO:<postmaster@domain>\n");
304 new_domain_record.postmaster_result = ccache_accept;
305 new_domain_record.postmaster_stamp = cache_record->postmaster_stamp;
309 /* We can't give a result based on information about the domain. See if there
310 is an unexpired cache record for this specific address (combined with the
311 sender address if we are doing a recipient callout with a non-empty sender).
314 cache_address_record = (dbdata_callout_cache_address *)
315 get_callout_cache_record(dbm_file,
316 address_key, US"address",
317 callout_cache_positive_expire,
318 callout_cache_negative_expire);
320 if (cache_address_record != NULL)
322 if (cache_address_record->result == ccache_accept)
325 debug_printf("callout cache: address record is positive\n");
330 debug_printf("callout cache: address record is negative\n");
331 addr->user_message = US"Previous (cached) callout verification failure";
337 /* Close the cache database while we actually do the callout for real. */
340 dbfn_close(dbm_file);
344 /* The information wasn't available in the cache, so we have to do a real
345 callout and save the result in the cache for next time, unless no_cache is set,
346 or unless we have a previously cached negative random result. If we are to test
347 with a random local part, ensure that such a local part is available. If not,
348 log the fact, but carry on without randomming. */
350 if (callout_random && callout_random_local_part != NULL)
352 random_local_part = expand_string(callout_random_local_part);
353 if (random_local_part == NULL)
354 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand "
355 "callout_random_local_part: %s", expand_string_message);
358 /* Default the overall callout timeout if not set, and record the time we are
359 starting so that we can enforce it. */
361 if (callout_overall < 0) callout_overall = 4 * callout;
362 callout_start_time = time(NULL);
364 /* Now make connections to the hosts and do real callouts. The list of hosts
365 is passed in as an argument. */
367 for (host = host_list; host != NULL && !done; host = host->next)
369 smtp_inblock inblock;
370 smtp_outblock outblock;
373 uschar *helo = US"HELO";
374 uschar *interface = NULL; /* Outgoing interface to use; NULL => any */
375 uschar inbuffer[4096];
376 uschar outbuffer[1024];
377 uschar responsebuffer[4096];
379 clearflag(addr, af_verify_pmfail); /* postmaster callout flag */
380 clearflag(addr, af_verify_nsfail); /* null sender callout flag */
382 /* Skip this host if we don't have an IP address for it. */
384 if (host->address == NULL)
386 DEBUG(D_verify) debug_printf("no IP address for host name %s: skipping\n",
391 /* Check the overall callout timeout */
393 if (time(NULL) - callout_start_time >= callout_overall)
395 HDEBUG(D_verify) debug_printf("overall timeout for callout exceeded\n");
399 /* Set IPv4 or IPv6 */
401 host_af = (Ustrchr(host->address, ':') == NULL)? AF_INET:AF_INET6;
403 /* Expand and interpret the interface and port strings. This has to
404 be delayed till now, because they may expand differently for different
405 hosts. If there's a failure, log it, but carry on with the defaults. */
407 deliver_host = host->name;
408 deliver_host_address = host->address;
409 if (!smtp_get_interface(tf->interface, host_af, addr, NULL, &interface,
411 !smtp_get_port(tf->port, addr, &port, US"callout"))
412 log_write(0, LOG_MAIN|LOG_PANIC, "<%s>: %s", addr->address,
414 deliver_host = deliver_host_address = NULL;
416 /* Set HELO string according to the protocol */
418 if (Ustrcmp(tf->protocol, "lmtp") == 0) helo = US"LHLO";
420 HDEBUG(D_verify) debug_printf("interface=%s port=%d\n", interface, port);
422 /* Set up the buffer for reading SMTP response packets. */
424 inblock.buffer = inbuffer;
425 inblock.buffersize = sizeof(inbuffer);
426 inblock.ptr = inbuffer;
427 inblock.ptrend = inbuffer;
429 /* Set up the buffer for holding SMTP commands while pipelining */
431 outblock.buffer = outbuffer;
432 outblock.buffersize = sizeof(outbuffer);
433 outblock.ptr = outbuffer;
434 outblock.cmd_count = 0;
435 outblock.authenticating = FALSE;
437 /* Connect to the host; on failure, just loop for the next one, but we
438 set the error for the last one. */
440 inblock.sock = outblock.sock =
441 smtp_connect(host, host_af, port, interface, callout, TRUE);
442 if (inblock.sock < 0)
444 addr->message = string_sprintf("could not connect to %s [%s]: %s",
445 host->name, host->address, strerror(errno));
449 /* Wait for initial response, and then run the initial SMTP commands. The
450 smtp_write_command() function leaves its command in big_buffer. This is
451 used in error responses. Initialize it in case the connection is
454 Ustrcpy(big_buffer, "initial connection");
457 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
460 smtp_write_command(&outblock, FALSE, "%s %s\r\n", helo,
461 smtp_active_hostname) >= 0 &&
462 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
465 smtp_write_command(&outblock, FALSE, "MAIL FROM:<%s>\r\n",
466 from_address) >= 0 &&
467 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
470 /* If the host gave an initial error, or does not accept HELO or MAIL
471 FROM:<>, arrange to cache this information, but don't record anything for an
472 I/O error or a defer. Do not cache rejections when a non-empty sender has
473 been used, because that blocks the whole domain for all senders. */
477 if (errno == 0 && responsebuffer[0] == '5')
479 setflag(addr, af_verify_nsfail);
480 if (from_address[0] == 0) new_domain_record.result = ccache_reject;
484 /* Otherwise, proceed to check a "random" address (if required), then the
485 given address, and the postmaster address (if required). Between each check,
486 issue RSET, because some servers accept only one recipient after MAIL
491 new_domain_record.result = ccache_accept;
493 /* Do the random local part check first */
495 if (random_local_part != NULL)
497 uschar randombuffer[1024];
499 smtp_write_command(&outblock, FALSE,
500 "RCPT TO:<%.1000s@%.1000s>\r\n", random_local_part,
501 addr->domain) >= 0 &&
502 smtp_read_response(&inblock, randombuffer,
503 sizeof(randombuffer), '2', callout);
505 /* Remember when we last did a random test */
507 new_domain_record.random_stamp = time(NULL);
509 /* If accepted, we aren't going to do any further tests below. */
513 new_domain_record.random_result = ccache_accept;
516 /* Otherwise, cache a real negative response, and get back to the right
517 state to send RCPT. Unless there's some problem such as a dropped
518 connection, we expect to succeed, because the commands succeeded above. */
522 if (randombuffer[0] == '5')
523 new_domain_record.random_result = ccache_reject;
526 smtp_write_command(&outblock, FALSE, "RSET\r\n") >= 0 &&
527 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
530 smtp_write_command(&outblock, FALSE, "MAIL FROM:<>\r\n") >= 0 &&
531 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
534 else done = FALSE; /* Some timeout/connection problem */
537 /* If the host is accepting all local parts, as determined by the "random"
538 check, we don't need to waste time doing any further checking. */
540 if (new_domain_record.random_result != ccache_accept && done)
543 smtp_write_command(&outblock, FALSE, "RCPT TO:<%.1000s>\r\n",
544 addr->address) >= 0 &&
545 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
549 new_address_record.result = ccache_accept;
550 else if (errno == 0 && responsebuffer[0] == '5')
551 new_address_record.result = ccache_reject;
553 /* Do postmaster check if requested */
555 if (done && pm_mailfrom != NULL)
558 smtp_write_command(&outblock, FALSE, "RSET\r\n") >= 0 &&
559 smtp_read_response(&inblock, responsebuffer,
560 sizeof(responsebuffer), '2', callout) &&
562 smtp_write_command(&outblock, FALSE,
563 "MAIL FROM:<%s>\r\n", pm_mailfrom) >= 0 &&
564 smtp_read_response(&inblock, responsebuffer,
565 sizeof(responsebuffer), '2', callout) &&
567 smtp_write_command(&outblock, FALSE,
568 "RCPT TO:<postmaster@%.1000s>\r\n", addr->domain) >= 0 &&
569 smtp_read_response(&inblock, responsebuffer,
570 sizeof(responsebuffer), '2', callout);
572 new_domain_record.postmaster_stamp = time(NULL);
575 new_domain_record.postmaster_result = ccache_accept;
576 else if (errno == 0 && responsebuffer[0] == '5')
578 setflag(addr, af_verify_pmfail);
579 new_domain_record.postmaster_result = ccache_reject;
582 } /* Random not accepted */
583 } /* MAIL FROM:<> accepted */
585 /* For any failure of the main check, other than a negative response, we just
586 close the connection and carry on. We can identify a negative response by the
587 fact that errno is zero. For I/O errors it will be non-zero
589 Set up different error texts for logging and for sending back to the caller
590 as an SMTP response. Log in all cases, using a one-line format. For sender
591 callouts, give a full response to the caller, but for recipient callouts,
592 don't give the IP address because this may be an internal host whose identity
593 is not to be widely broadcast. */
597 if (errno == ETIMEDOUT)
599 HDEBUG(D_verify) debug_printf("SMTP timeout\n");
603 if (*responsebuffer == 0) Ustrcpy(responsebuffer, US"connection dropped");
606 string_sprintf("response to \"%s\" from %s [%s] was: %s",
607 big_buffer, host->name, host->address,
608 string_printing(responsebuffer));
610 addr->user_message = is_recipient?
611 string_sprintf("Callout verification failed:\n%s", responsebuffer)
613 string_sprintf("Called: %s\nSent: %s\nResponse: %s",
614 host->address, big_buffer, responsebuffer);
616 /* Hard rejection ends the process */
618 if (responsebuffer[0] == '5') /* Address rejected */
626 /* End the SMTP conversation and close the connection. */
628 (void)smtp_write_command(&outblock, FALSE, "QUIT\r\n");
630 } /* Loop through all hosts, while !done */
632 /* If we get here with done == TRUE, a successful callout happened, and yield
633 will be set OK or FAIL according to the response to the RCPT command.
634 Otherwise, we looped through the hosts but couldn't complete the business.
635 However, there may be domain-specific information to cache in both cases.
637 The value of the result field in the new_domain record is ccache_unknown if
638 there was an error before or with MAIL FROM:<>, and errno was not zero,
639 implying some kind of I/O error. We don't want to write the cache in that case.
640 Otherwise the value is ccache_accept or ccache_reject. */
642 if (!callout_no_cache && new_domain_record.result != ccache_unknown)
644 if ((dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE))
647 HDEBUG(D_verify) debug_printf("callout cache: not available\n");
651 (void)dbfn_write(dbm_file, addr->domain, &new_domain_record,
652 (int)sizeof(dbdata_callout_cache));
653 HDEBUG(D_verify) debug_printf("wrote callout cache domain record:\n"
654 " result=%d postmaster=%d random=%d\n",
655 new_domain_record.result,
656 new_domain_record.postmaster_result,
657 new_domain_record.random_result);
661 /* If a definite result was obtained for the callout, cache it unless caching
666 if (!callout_no_cache && new_address_record.result != ccache_unknown)
668 if (dbm_file == NULL)
669 dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE);
670 if (dbm_file == NULL)
672 HDEBUG(D_verify) debug_printf("no callout cache available\n");
676 (void)dbfn_write(dbm_file, address_key, &new_address_record,
677 (int)sizeof(dbdata_callout_cache_address));
678 HDEBUG(D_verify) debug_printf("wrote %s callout cache address record\n",
679 (new_address_record.result == ccache_accept)? "positive" : "negative");
684 /* Failure to connect to any host, or any response other than 2xx or 5xx is a
685 temporary error. If there was only one host, and a response was received, leave
686 it alone if supplying details. Otherwise, give a generic response. */
690 uschar *dullmsg = string_sprintf("Could not complete %s verify callout",
691 is_recipient? "recipient" : "sender");
694 if (host_list->next != NULL || addr->message == NULL) addr->message = dullmsg;
696 addr->user_message = (!smtp_return_error_details)? dullmsg :
697 string_sprintf("%s for <%s>.\n"
698 "The mail server(s) for the domain may be temporarily unreachable, or\n"
699 "they may be permanently unreachable from this server. In the latter case,\n%s",
700 dullmsg, addr->address,
702 "the address will never be accepted."
704 "you need to change the address or create an MX record for its domain\n"
705 "if it is supposed to be generally accessible from the Internet.\n"
706 "Talk to your mail administrator for details.");
708 /* Force a specific error code */
710 addr->basic_errno = ERRNO_CALLOUTDEFER;
713 /* Come here from within the cache-reading code on fast-track exit. */
716 if (dbm_file != NULL) dbfn_close(dbm_file);
722 /*************************************************
723 * Copy error to toplevel address *
724 *************************************************/
726 /* This function is used when a verify fails or defers, to ensure that the
727 failure or defer information is in the original toplevel address. This applies
728 when an address is redirected to a single new address, and the failure or
729 deferral happens to the child address.
732 vaddr the verify address item
733 addr the final address item
736 Returns: the value of YIELD
740 copy_error(address_item *vaddr, address_item *addr, int yield)
744 vaddr->message = addr->message;
745 vaddr->user_message = addr->user_message;
746 vaddr->basic_errno = addr->basic_errno;
747 vaddr->more_errno = addr->more_errno;
755 /*************************************************
756 * Verify an email address *
757 *************************************************/
759 /* This function is used both for verification (-bv and at other times) and
760 address testing (-bt), which is indicated by address_test_mode being set.
763 vaddr contains the address to verify; the next field in this block
765 f if not NULL, write the result to this file
766 options various option bits:
767 vopt_fake_sender => this sender verify is not for the real
768 sender (it was verify=sender=xxxx or an address from a
769 header line) - rewriting must not change sender_address
770 vopt_is_recipient => this is a recipient address, otherwise
771 it's a sender address - this affects qualification and
772 rewriting and messages from callouts
773 vopt_qualify => qualify an unqualified address; else error
774 vopt_expn => called from SMTP EXPN command
776 These ones are used by do_callout() -- the options variable
779 vopt_callout_no_cache => don't use callout cache
780 vopt_callout_random => do the "random" thing
781 vopt_callout_recipsender => use real sender for recipient
782 vopt_callout_recippmaster => use postmaster for recipient
784 callout if > 0, specifies that callout is required, and gives timeout
785 for individual connections and commands
786 callout_overall if > 0, gives overall timeout for the callout function;
787 if < 0, a default is used (see do_callout())
788 se_mailfrom when callout is requested to verify a sender, use this
789 in MAIL FROM; NULL => ""
790 pm_mailfrom when callout is requested, if non-NULL, do the postmaster
791 thing and use this as the sender address (may be "")
793 routed if not NULL, set TRUE if routing succeeded, so we can
794 distinguish between routing failed and callout failed
796 Returns: OK address verified
797 FAIL address failed to verify
798 DEFER can't tell at present
802 verify_address(address_item *vaddr, FILE *f, int options, int callout,
803 int callout_overall, uschar *se_mailfrom, uschar *pm_mailfrom, BOOL *routed)
806 BOOL full_info = (f == NULL)? FALSE : (debug_selector != 0);
807 BOOL is_recipient = (options & vopt_is_recipient) != 0;
808 BOOL expn = (options & vopt_expn) != 0;
812 int verify_type = expn? v_expn :
813 address_test_mode? v_none :
814 is_recipient? v_recipient : v_sender;
815 address_item *addr_list;
816 address_item *addr_new = NULL;
817 address_item *addr_remote = NULL;
818 address_item *addr_local = NULL;
819 address_item *addr_succeed = NULL;
820 uschar *ko_prefix, *cr;
821 uschar *address = vaddr->address;
823 uschar null_sender[] = { 0 }; /* Ensure writeable memory */
825 /* Set up a prefix and suffix for error message which allow us to use the same
826 output statements both in EXPN mode (where an SMTP response is needed) and when
827 debugging with an output file. */
831 ko_prefix = US"553 ";
834 else ko_prefix = cr = US"";
836 /* Add qualify domain if permitted; otherwise an unqualified address fails. */
838 if (parse_find_at(address) == NULL)
840 if ((options & vopt_qualify) == 0)
843 fprintf(f, "%sA domain is required for \"%s\"%s\n", ko_prefix, address,
847 address = rewrite_address_qualify(address, is_recipient);
852 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
853 debug_printf("%s %s\n", address_test_mode? "Testing" : "Verifying", address);
856 /* Rewrite and report on it. Clear the domain and local part caches - these
857 may have been set by domains and local part tests during an ACL. */
859 if (global_rewrite_rules != NULL)
861 uschar *old = address;
862 address = rewrite_address(address, is_recipient, FALSE,
863 global_rewrite_rules, rewrite_existflags);
866 for (i = 0; i < (MAX_NAMED_LIST * 2)/32; i++) vaddr->localpart_cache[i] = 0;
867 for (i = 0; i < (MAX_NAMED_LIST * 2)/32; i++) vaddr->domain_cache[i] = 0;
868 if (f != NULL && !expn) fprintf(f, "Address rewritten as: %s\n", address);
872 /* If this is the real sender address, we must update sender_address at
873 this point, because it may be referred to in the routers. */
875 if ((options & (vopt_fake_sender|vopt_is_recipient)) == 0)
876 sender_address = address;
878 /* If the address was rewritten to <> no verification can be done, and we have
879 to return OK. This rewriting is permitted only for sender addresses; for other
880 addresses, such rewriting fails. */
882 if (address[0] == 0) return OK;
884 /* Save a copy of the sender address for re-instating if we change it to <>
885 while verifying a sender address (a nice bit of self-reference there). */
887 save_sender = sender_address;
889 /* Update the address structure with the possibly qualified and rewritten
890 address. Set it up as the starting address on the chain of new addresses. */
892 vaddr->address = address;
895 /* We need a loop, because an address can generate new addresses. We must also
896 cope with generated pipes and files at the top level. (See also the code and
897 comment in deliver.c.) However, it is usually the case that the router for
898 user's .forward files has its verify flag turned off.
900 If an address generates more than one child, the loop is used only when
901 full_info is set, and this can only be set locally. Remote enquiries just get
902 information about the top level address, not anything that it generated. */
904 while (addr_new != NULL)
907 address_item *addr = addr_new;
909 addr_new = addr->next;
914 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
915 debug_printf("Considering %s\n", addr->address);
918 /* Handle generated pipe, file or reply addresses. We don't get these
919 when handling EXPN, as it does only one level of expansion. */
921 if (testflag(addr, af_pfr))
928 if (addr->address[0] == '>')
930 allow = testflag(addr, af_allow_reply);
931 fprintf(f, "%s -> mail %s", addr->parent->address, addr->address + 1);
935 allow = (addr->address[0] == '|')?
936 testflag(addr, af_allow_pipe) : testflag(addr, af_allow_file);
937 fprintf(f, "%s -> %s", addr->parent->address, addr->address);
940 if (addr->basic_errno == ERRNO_BADTRANSPORT)
941 fprintf(f, "\n*** Error in setting up pipe, file, or autoreply:\n"
942 "%s\n", addr->message);
944 fprintf(f, "\n transport = %s\n", addr->transport->name);
946 fprintf(f, " *** forbidden ***\n");
951 /* Just in case some router parameter refers to it. */
953 return_path = (addr->p.errors_address != NULL)?
954 addr->p.errors_address : sender_address;
956 /* Split the address into domain and local part, handling the %-hack if
957 necessary, and then route it. While routing a sender address, set
958 $sender_address to <> because that is what it will be if we were trying to
959 send a bounce to the sender. */
961 if (routed != NULL) *routed = FALSE;
962 if ((rc = deliver_split_address(addr)) == OK)
964 if (!is_recipient) sender_address = null_sender;
965 rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
966 &addr_succeed, verify_type);
967 sender_address = save_sender; /* Put back the real sender */
970 /* If routing an address succeeded, set the flag that remembers, for use when
971 an ACL cached a sender verify (in case a callout fails). Then if routing set
972 up a list of hosts or the transport has a host list, and the callout option
973 is set, and we aren't in a host checking run, do the callout verification,
974 and set another flag that notes that a callout happened. */
978 if (routed != NULL) *routed = TRUE;
981 host_item *host_list = addr->host_list;
983 /* Default, if no remote transport, to NULL for the interface (=> any),
984 "smtp" for the port, and "smtp" for the protocol. */
986 transport_feedback tf = { NULL, US"smtp", US"smtp", NULL, FALSE, FALSE };
988 /* If verification yielded a remote transport, we want to use that
989 transport's options, so as to mimic what would happen if we were really
990 sending a message to this address. */
992 if (addr->transport != NULL && !addr->transport->info->local)
994 (void)(addr->transport->setup)(addr->transport, addr, &tf, NULL);
996 /* If the transport has hosts and the router does not, or if the
997 transport is configured to override the router's hosts, we must build a
998 host list of the transport's hosts, and find the IP addresses */
1000 if (tf.hosts != NULL && (host_list == NULL || tf.hosts_override))
1004 host_list = NULL; /* Ignore the router's hosts */
1006 deliver_domain = addr->domain;
1007 deliver_localpart = addr->local_part;
1008 s = expand_string(tf.hosts);
1009 deliver_domain = deliver_localpart = NULL;
1013 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand list of hosts "
1014 "\"%s\" in %s transport for callout: %s", tf.hosts,
1015 addr->transport->name, expand_string_message);
1019 uschar *canonical_name;
1021 host_build_hostlist(&host_list, s, tf.hosts_randomize);
1023 /* Just ignore failures to find a host address. If we don't manage
1024 to find any addresses, the callout will defer. */
1026 for (host = host_list; host != NULL; host = host->next)
1028 if (tf.gethostbyname || string_is_ip_address(host->name, NULL))
1029 (void)host_find_byname(host, NULL, &canonical_name, TRUE);
1032 int flags = HOST_FIND_BY_A;
1033 if (tf.qualify_single) flags |= HOST_FIND_QUALIFY_SINGLE;
1034 if (tf.search_parents) flags |= HOST_FIND_SEARCH_PARENTS;
1035 (void)host_find_bydns(host, NULL, flags, NULL, NULL, NULL,
1036 &canonical_name, NULL);
1043 /* Can only do a callout if we have at least one host! */
1045 if (host_list != NULL)
1047 HDEBUG(D_verify) debug_printf("Attempting full verification using callout\n");
1048 if (host_checking && !host_checking_callout)
1051 debug_printf("... callout omitted by default when host testing\n"
1052 "(Use -bhc if you want the callouts to happen.)\n");
1056 rc = do_callout(addr, host_list, &tf, callout, callout_overall,
1057 options, se_mailfrom, pm_mailfrom);
1062 HDEBUG(D_verify) debug_printf("Cannot do callout: neither router nor "
1063 "transport provided a host list\n");
1068 /* A router may return REROUTED if it has set up a child address as a result
1069 of a change of domain name (typically from widening). In this case we always
1070 want to continue to verify the new child. */
1072 if (rc == REROUTED) continue;
1074 /* Handle hard failures */
1081 fprintf(f, "%s%s %s", ko_prefix, address,
1082 address_test_mode? "is undeliverable" : "failed to verify");
1083 if (!expn && admin_user)
1085 if (addr->basic_errno > 0)
1086 fprintf(f, ": %s", strerror(addr->basic_errno));
1087 if (addr->message != NULL)
1088 fprintf(f, ":\n %s", addr->message);
1090 fprintf(f, "%s\n", cr);
1093 if (!full_info) return copy_error(vaddr, addr, FAIL);
1099 else if (rc == DEFER)
1104 fprintf(f, "%s%s cannot be resolved at this time", ko_prefix, address);
1105 if (!expn && admin_user)
1107 if (addr->basic_errno > 0)
1108 fprintf(f, ":\n %s", strerror(addr->basic_errno));
1109 if (addr->message != NULL)
1110 fprintf(f, ":\n %s", addr->message);
1111 else if (addr->basic_errno <= 0)
1112 fprintf(f, ":\n unknown error");
1115 fprintf(f, "%s\n", cr);
1117 if (!full_info) return copy_error(vaddr, addr, DEFER);
1118 else if (yield == OK) yield = DEFER;
1121 /* If we are handling EXPN, we do not want to continue to route beyond
1126 uschar *ok_prefix = US"250-";
1127 if (addr_new == NULL)
1129 if (addr_local == NULL && addr_remote == NULL)
1130 fprintf(f, "250 mail to <%s> is discarded\r\n", address);
1132 fprintf(f, "250 <%s>\r\n", address);
1134 else while (addr_new != NULL)
1136 address_item *addr2 = addr_new;
1137 addr_new = addr2->next;
1138 if (addr_new == NULL) ok_prefix = US"250 ";
1139 fprintf(f, "%s<%s>\r\n", ok_prefix, addr2->address);
1144 /* Successful routing other than EXPN. */
1148 /* Handle successful routing when short info wanted. Otherwise continue for
1149 other (generated) addresses. Short info is the operational case. Full info
1150 can be requested only when debug_selector != 0 and a file is supplied.
1152 There is a conflict between the use of aliasing as an alternate email
1153 address, and as a sort of mailing list. If an alias turns the incoming
1154 address into just one address (e.g. J.Caesar->jc44) you may well want to
1155 carry on verifying the generated address to ensure it is valid when
1156 checking incoming mail. If aliasing generates multiple addresses, you
1157 probably don't want to do this. Exim therefore treats the generation of
1158 just a single new address as a special case, and continues on to verify the
1159 generated address. */
1161 if (!full_info && /* Stop if short info wanted AND */
1162 (addr_new == NULL || /* No new address OR */
1163 addr_new->next != NULL || /* More than one new address OR */
1164 testflag(addr_new, af_pfr))) /* New address is pfr */
1166 if (f != NULL) fprintf(f, "%s %s\n", address,
1167 address_test_mode? "is deliverable" : "verified");
1169 /* If we have carried on to verify a child address, we want the value
1170 of $address_data to be that of the child */
1172 vaddr->p.address_data = addr->p.address_data;
1176 } /* Loop for generated addresses */
1178 /* Display the full results of the successful routing, including any generated
1179 addresses. Control gets here only when full_info is set, which requires f not
1180 to be NULL, and this occurs only when a top-level verify is called with the
1181 debugging switch on.
1183 If there are no local and no remote addresses, and there were no pipes, files,
1184 or autoreplies, and there were no errors or deferments, the message is to be
1185 discarded, usually because of the use of :blackhole: in an alias file. */
1187 if (allok && addr_local == NULL && addr_remote == NULL)
1188 fprintf(f, "mail to %s is discarded\n", address);
1190 else for (addr_list = addr_local, i = 0; i < 2; addr_list = addr_remote, i++)
1192 while (addr_list != NULL)
1194 address_item *addr = addr_list;
1195 address_item *p = addr->parent;
1196 addr_list = addr->next;
1198 fprintf(f, "%s", CS addr->address);
1201 fprintf(f, "\n <-- %s", p->address);
1206 /* Show router, and transport */
1208 fprintf(f, "router = %s, ", addr->router->name);
1209 fprintf(f, "transport = %s\n", (addr->transport == NULL)? US"unset" :
1210 addr->transport->name);
1212 /* Show any hosts that are set up by a router unless the transport
1213 is going to override them; fiddle a bit to get a nice format. */
1215 if (addr->host_list != NULL && addr->transport != NULL &&
1216 !addr->transport->overrides_hosts)
1221 for (h = addr->host_list; h != NULL; h = h->next)
1223 int len = Ustrlen(h->name);
1224 if (len > maxlen) maxlen = len;
1225 len = (h->address != NULL)? Ustrlen(h->address) : 7;
1226 if (len > maxaddlen) maxaddlen = len;
1228 for (h = addr->host_list; h != NULL; h = h->next)
1230 int len = Ustrlen(h->name);
1231 fprintf(f, " host %s ", h->name);
1232 while (len++ < maxlen) fprintf(f, " ");
1233 if (h->address != NULL)
1235 fprintf(f, "[%s] ", h->address);
1236 len = Ustrlen(h->address);
1238 else if (!addr->transport->info->local) /* Omit [unknown] for local */
1240 fprintf(f, "[unknown] ");
1244 while (len++ < maxaddlen) fprintf(f," ");
1245 if (h->mx >= 0) fprintf(f, "MX=%d", h->mx);
1246 if (h->port != PORT_NONE) fprintf(f, " port=%d", h->port);
1247 if (h->status == hstatus_unusable) fprintf(f, " ** unusable **");
1254 return yield; /* Will be DEFER or FAIL if any one address has */
1260 /*************************************************
1261 * Check headers for syntax errors *
1262 *************************************************/
1264 /* This function checks those header lines that contain addresses, and verifies
1265 that all the addresses therein are syntactially correct.
1268 msgptr where to put an error message
1275 verify_check_headers(uschar **msgptr)
1280 for (h = header_list; h != NULL; h = h->next)
1282 if (h->type != htype_from &&
1283 h->type != htype_reply_to &&
1284 h->type != htype_sender &&
1285 h->type != htype_to &&
1286 h->type != htype_cc &&
1287 h->type != htype_bcc)
1290 colon = Ustrchr(h->text, ':');
1292 while (isspace(*s)) s++;
1294 parse_allow_group = TRUE; /* Allow group syntax */
1296 /* Loop for multiple addresses in the header */
1300 uschar *ss = parse_find_address_end(s, FALSE);
1301 uschar *recipient, *errmess;
1302 int terminator = *ss;
1303 int start, end, domain;
1305 /* Temporarily terminate the string at this point, and extract the
1306 operative address within. */
1309 recipient = parse_extract_address(s,&errmess,&start,&end,&domain,FALSE);
1312 /* Permit an unqualified address only if the message is local, or if the
1313 sending host is configured to be permitted to send them. */
1315 if (recipient != NULL && domain == 0)
1317 if (h->type == htype_from || h->type == htype_sender)
1319 if (!allow_unqualified_sender) recipient = NULL;
1323 if (!allow_unqualified_recipient) recipient = NULL;
1325 if (recipient == NULL) errmess = US"unqualified address not permitted";
1328 /* It's an error if no address could be extracted, except for the special
1329 case of an empty address. */
1331 if (recipient == NULL && Ustrcmp(errmess, "empty address") != 0)
1333 uschar *verb = US"is";
1337 /* Arrange not to include any white space at the end in the
1340 while (t > s && isspace(t[-1])) t--;
1342 /* Add the address which failed to the error message, since in a
1343 header with very many addresses it is sometimes hard to spot
1344 which one is at fault. However, limit the amount of address to
1345 quote - cases have been seen where, for example, a missing double
1346 quote in a humungous To: header creates an "address" that is longer
1347 than string_sprintf can handle. */
1356 *msgptr = string_printing(
1357 string_sprintf("%s: failing address in \"%.*s\" header %s: %.*s",
1358 errmess, colon - h->text, h->text, verb, len, s));
1363 /* Advance to the next address */
1365 s = ss + (terminator? 1:0);
1366 while (isspace(*s)) s++;
1367 } /* Next address */
1376 /*************************************************
1377 * Find if verified sender *
1378 *************************************************/
1380 /* Usually, just a single address is verified as the sender of the message.
1381 However, Exim can be made to verify other addresses as well (often related in
1382 some way), and this is useful in some environments. There may therefore be a
1383 chain of such addresses that have previously been tested. This function finds
1384 whether a given address is on the chain.
1386 Arguments: the address to be verified
1387 Returns: pointer to an address item, or NULL
1391 verify_checked_sender(uschar *sender)
1394 for (addr = sender_verified_list; addr != NULL; addr = addr->next)
1395 if (Ustrcmp(sender, addr->address) == 0) break;
1403 /*************************************************
1404 * Get valid header address *
1405 *************************************************/
1407 /* Scan the originator headers of the message, looking for an address that
1408 verifies successfully. RFC 822 says:
1410 o The "Sender" field mailbox should be sent notices of
1411 any problems in transport or delivery of the original
1412 messages. If there is no "Sender" field, then the
1413 "From" field mailbox should be used.
1415 o If the "Reply-To" field exists, then the reply should
1416 go to the addresses indicated in that field and not to
1417 the address(es) indicated in the "From" field.
1419 So we check a Sender field if there is one, else a Reply_to field, else a From
1420 field. As some strange messages may have more than one of these fields,
1421 especially if they are resent- fields, check all of them if there is more than
1425 user_msgptr points to where to put a user error message
1426 log_msgptr points to where to put a log error message
1427 callout timeout for callout check (passed to verify_address())
1428 callout_overall overall callout timeout (ditto)
1429 se_mailfrom mailfrom for verify; NULL => ""
1430 pm_mailfrom sender for pm callout check (passed to verify_address())
1431 options callout options (passed to verify_address())
1433 If log_msgptr is set to something without setting user_msgptr, the caller
1434 normally uses log_msgptr for both things.
1436 Returns: result of the verification attempt: OK, FAIL, or DEFER;
1437 FAIL is given if no appropriate headers are found
1441 verify_check_header_address(uschar **user_msgptr, uschar **log_msgptr,
1442 int callout, int callout_overall, uschar *se_mailfrom, uschar *pm_mailfrom,
1445 static int header_types[] = { htype_sender, htype_reply_to, htype_from };
1449 for (i = 0; i < 3; i++)
1452 for (h = header_list; h != NULL; h = h->next)
1454 int terminator, new_ok;
1455 uschar *s, *ss, *endname;
1457 if (h->type != header_types[i]) continue;
1458 s = endname = Ustrchr(h->text, ':') + 1;
1462 address_item *vaddr;
1464 while (isspace(*s) || *s == ',') s++;
1465 if (*s == 0) break; /* End of header */
1467 ss = parse_find_address_end(s, FALSE);
1469 /* The terminator is a comma or end of header, but there may be white
1470 space preceding it (including newline for the last address). Move back
1471 past any white space so we can check against any cached envelope sender
1472 address verifications. */
1474 while (isspace(ss[-1])) ss--;
1478 HDEBUG(D_verify) debug_printf("verifying %.*s header address %s\n",
1479 (int)(endname - h->text), h->text, s);
1481 /* See if we have already verified this address as an envelope sender,
1482 and if so, use the previous answer. */
1484 vaddr = verify_checked_sender(s);
1486 if (vaddr != NULL && /* Previously checked */
1487 (callout <= 0 || /* No callout needed; OR */
1488 vaddr->special_action > 256)) /* Callout was done */
1490 new_ok = vaddr->special_action & 255;
1491 HDEBUG(D_verify) debug_printf("previously checked as envelope sender\n");
1492 *ss = terminator; /* Restore shortened string */
1495 /* Otherwise we run the verification now. We must restore the shortened
1496 string before running the verification, so the headers are correct, in
1497 case there is any rewriting. */
1501 int start, end, domain;
1502 uschar *address = parse_extract_address(s, log_msgptr, &start,
1503 &end, &domain, FALSE);
1507 /* If verification failed because of a syntax error, fail this
1508 function, and ensure that the failing address gets added to the error
1511 if (address == NULL)
1514 if (*log_msgptr != NULL)
1516 while (ss > s && isspace(ss[-1])) ss--;
1517 *log_msgptr = string_sprintf("syntax error in '%.*s' header when "
1518 "scanning for sender: %s in \"%.*s\"",
1519 endname - h->text, h->text, *log_msgptr, ss - s, s);
1524 /* Else go ahead with the sender verification. But is isn't *the*
1525 sender of the message, so set vopt_fake_sender to stop sender_address
1526 being replaced after rewriting or qualification. */
1530 vaddr = deliver_make_addr(address, FALSE);
1531 new_ok = verify_address(vaddr, NULL, options | vopt_fake_sender,
1532 callout, callout_overall, se_mailfrom, pm_mailfrom, NULL);
1536 /* We now have the result, either newly found, or cached. If we are
1537 giving out error details, set a specific user error. This means that the
1538 last of these will be returned to the user if all three fail. We do not
1539 set a log message - the generic one below will be used. */
1541 if (new_ok != OK && smtp_return_error_details)
1543 *user_msgptr = string_sprintf("Rejected after DATA: "
1544 "could not verify \"%.*s\" header address\n%s: %s",
1545 endname - h->text, h->text, vaddr->address, vaddr->message);
1548 /* Success or defer */
1550 if (new_ok == OK) return OK;
1551 if (new_ok == DEFER) yield = DEFER;
1553 /* Move on to any more addresses in the header */
1560 if (yield == FAIL && *log_msgptr == NULL)
1561 *log_msgptr = US"there is no valid sender in any header line";
1563 if (yield == DEFER && *log_msgptr == NULL)
1564 *log_msgptr = US"all attempts to verify a sender in a header line deferred";
1572 /*************************************************
1573 * Get RFC 1413 identification *
1574 *************************************************/
1576 /* Attempt to get an id from the sending machine via the RFC 1413 protocol. If
1577 the timeout is set to zero, then the query is not done. There may also be lists
1578 of hosts and nets which are exempt. To guard against malefactors sending
1579 non-printing characters which could, for example, disrupt a message's headers,
1580 make sure the string consists of printing characters only.
1583 port the port to connect to; usually this is IDENT_PORT (113), but when
1584 running in the test harness with -bh a different value is used.
1588 Side effect: any received ident value is put in sender_ident (NULL otherwise)
1592 verify_get_ident(int port)
1594 int sock, host_af, qlen;
1595 int received_sender_port, received_interface_port, n;
1597 uschar buffer[2048];
1599 /* Default is no ident. Check whether we want to do an ident check for this
1602 sender_ident = NULL;
1603 if (rfc1413_query_timeout <= 0 || verify_check_host(&rfc1413_hosts) != OK)
1606 DEBUG(D_ident) debug_printf("doing ident callback\n");
1608 /* Set up a connection to the ident port of the remote host. Bind the local end
1609 to the incoming interface address. If the sender host address is an IPv6
1610 address, the incoming interface address will also be IPv6. */
1612 host_af = (Ustrchr(sender_host_address, ':') == NULL)? AF_INET : AF_INET6;
1613 sock = ip_socket(SOCK_STREAM, host_af);
1614 if (sock < 0) return;
1616 if (ip_bind(sock, host_af, interface_address, 0) < 0)
1618 DEBUG(D_ident) debug_printf("bind socket for ident failed: %s\n",
1623 if (ip_connect(sock, host_af, sender_host_address, port, rfc1413_query_timeout)
1626 if (errno == ETIMEDOUT && (log_extra_selector & LX_ident_timeout) != 0)
1628 log_write(0, LOG_MAIN, "ident connection to %s timed out",
1629 sender_host_address);
1633 DEBUG(D_ident) debug_printf("ident connection to %s failed: %s\n",
1634 sender_host_address, strerror(errno));
1639 /* Construct and send the query. */
1641 sprintf(CS buffer, "%d , %d\r\n", sender_host_port, interface_port);
1642 qlen = Ustrlen(buffer);
1643 if (send(sock, buffer, qlen, 0) < 0)
1645 DEBUG(D_ident) debug_printf("ident send failed: %s\n", strerror(errno));
1649 /* Read a response line. We put it into the rest of the buffer, using several
1650 recv() calls if necessary. */
1658 int size = sizeof(buffer) - (p - buffer);
1660 if (size <= 0) goto END_OFF; /* Buffer filled without seeing \n. */
1661 count = ip_recv(sock, p, size, rfc1413_query_timeout);
1662 if (count <= 0) goto END_OFF; /* Read error or EOF */
1664 /* Scan what we just read, to see if we have reached the terminating \r\n. Be
1665 generous, and accept a plain \n terminator as well. The only illegal
1668 for (pp = p; pp < p + count; pp++)
1670 if (*pp == 0) goto END_OFF; /* Zero octet not allowed */
1673 if (pp[-1] == '\r') pp--;
1675 goto GOT_DATA; /* Break out of both loops */
1679 /* Reached the end of the data without finding \n. Let the loop continue to
1680 read some more, if there is room. */
1687 /* We have received a line of data. Check it carefully. It must start with the
1688 same two port numbers that we sent, followed by data as defined by the RFC. For
1691 12345 , 25 : USERID : UNIX :root
1693 However, the amount of white space may be different to what we sent. In the
1694 "osname" field there may be several sub-fields, comma separated. The data we
1695 actually want to save follows the third colon. Some systems put leading spaces
1696 in it - we discard those. */
1698 if (sscanf(CS buffer + qlen, "%d , %d%n", &received_sender_port,
1699 &received_interface_port, &n) != 2 ||
1700 received_sender_port != sender_host_port ||
1701 received_interface_port != interface_port)
1704 p = buffer + qlen + n;
1705 while(isspace(*p)) p++;
1706 if (*p++ != ':') goto END_OFF;
1707 while(isspace(*p)) p++;
1708 if (Ustrncmp(p, "USERID", 6) != 0) goto END_OFF;
1710 while(isspace(*p)) p++;
1711 if (*p++ != ':') goto END_OFF;
1712 while (*p != 0 && *p != ':') p++;
1713 if (*p++ == 0) goto END_OFF;
1714 while(isspace(*p)) p++;
1715 if (*p == 0) goto END_OFF;
1717 /* The rest of the line is the data we want. We turn it into printing
1718 characters when we save it, so that it cannot mess up the format of any logging
1719 or Received: lines into which it gets inserted. We keep a maximum of 127
1722 sender_ident = string_printing(string_copyn(p, 127));
1723 DEBUG(D_ident) debug_printf("sender_ident = %s\n", sender_ident);
1733 /*************************************************
1734 * Match host to a single host-list item *
1735 *************************************************/
1737 /* This function compares a host (name or address) against a single item
1738 from a host list. The host name gets looked up if it is needed and is not
1739 already known. The function is called from verify_check_this_host() via
1740 match_check_list(), which is why most of its arguments are in a single block.
1743 arg the argument block (see below)
1744 ss the host-list item
1745 valueptr where to pass back looked up data, or NULL
1746 error for error message when returning ERROR
1749 host_name the host name or NULL, implying use sender_host_name and
1750 sender_host_aliases, looking them up if required
1751 host_address the host address
1752 host_ipv4 the IPv4 address taken from an IPv6 one
1756 DEFER lookup deferred
1757 ERROR failed to find the host name or IP address
1758 unknown lookup type specified
1762 check_host(void *arg, uschar *ss, uschar **valueptr, uschar **error)
1764 check_host_block *cb = (check_host_block *)arg;
1766 BOOL isquery = FALSE;
1767 uschar *semicolon, *t;
1770 /* Optimize for the special case when the pattern is "*". */
1772 if (*ss == '*' && ss[1] == 0) return OK;
1774 /* If the pattern is empty, it matches only in the case when there is no host -
1775 this can occur in ACL checking for SMTP input using the -bs option. In this
1776 situation, the host address is the empty string. */
1778 if (cb->host_address[0] == 0) return (*ss == 0)? OK : FAIL;
1779 if (*ss == 0) return FAIL;
1781 /* If the pattern is precisely "@" then match against the primary host name;
1782 if it's "@[]" match against the local host's IP addresses. */
1786 if (ss[1] == 0) ss = primary_hostname;
1787 else if (Ustrcmp(ss, "@[]") == 0)
1789 ip_address_item *ip;
1790 for (ip = host_find_interfaces(); ip != NULL; ip = ip->next)
1791 if (Ustrcmp(ip->address, cb->host_address) == 0) return OK;
1796 /* If the pattern is an IP address, optionally followed by a bitmask count, do
1797 a (possibly masked) comparision with the current IP address. */
1799 if (string_is_ip_address(ss, &maskoffset))
1800 return (host_is_in_net(cb->host_address, ss, maskoffset)? OK : FAIL);
1802 /* If the item is of the form net[n]-lookup;<file|query> then it is a lookup on
1803 a masked IP network, in textual form. The net- stuff really only applies to
1804 single-key lookups where the key is implicit. For query-style lookups the key
1805 is specified in the query. From release 4.30, the use of net- for query style
1806 is no longer needed, but we retain it for backward compatibility. */
1808 if (Ustrncmp(ss, "net", 3) == 0 && (semicolon = Ustrchr(ss, ';')) != NULL)
1811 for (t = ss + 3; isdigit(*t); t++) mlen = mlen * 10 + *t - '0';
1818 uschar *filename, *key, *result;
1821 /* If no mask was supplied, set a negative value */
1823 if (mlen == 0 && t == ss+4) mlen = -1;
1825 /* Find the search type */
1827 search_type = search_findtype(t, semicolon - t);
1829 if (search_type < 0) log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s",
1830 search_error_message);
1832 /* Adjust parameters for the type of lookup. For a query-style
1833 lookup, there is no file name, and the "key" is just the query. For
1834 a single-key lookup, the key is the current IP address, masked
1835 appropriately, and reconverted to text form, with the mask appended. */
1837 if (mac_islookup(search_type, lookup_querystyle))
1840 key = semicolon + 1;
1844 insize = host_aton(cb->host_address, incoming);
1845 host_mask(insize, incoming, mlen);
1846 (void)host_nmtoa(insize, incoming, mlen, buffer);
1848 filename = semicolon + 1;
1851 /* Now do the actual lookup; note that there is no search_close() because
1852 of the caching arrangements. */
1854 handle = search_open(filename, search_type, 0, NULL, NULL);
1855 if (handle == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s",
1856 search_error_message);
1857 result = search_find(handle, filename, key, -1, NULL, 0, 0, NULL);
1858 if (valueptr != NULL) *valueptr = result;
1859 return (result != NULL)? OK : search_find_defer? DEFER: FAIL;
1863 /* The pattern is not an IP address or network reference of any kind. That is,
1864 it is a host name pattern. Check the characters of the pattern to see if they
1865 comprise only letters, digits, full stops, and hyphens (the constituents of
1866 domain names). Allow underscores, as they are all too commonly found. Sigh.
1867 Also, if allow_utf8_domains is set, allow top-bit characters. */
1869 for (t = ss; *t != 0; t++)
1870 if (!isalnum(*t) && *t != '.' && *t != '-' && *t != '_' &&
1871 (!allow_utf8_domains || *t < 128)) break;
1873 /* If the pattern is a complete domain name, with no fancy characters, look up
1874 its IP address and match against that. Note that a multi-homed host will add
1875 items to the chain. */
1885 rc = host_find_byname(&h, NULL, NULL, FALSE);
1886 if (rc == HOST_FOUND || rc == HOST_FOUND_LOCAL)
1889 for (hh = &h; hh != NULL; hh = hh->next)
1891 if (Ustrcmp(hh->address, (Ustrchr(hh->address, ':') == NULL)?
1892 cb->host_ipv4 : cb->host_address) == 0)
1897 if (rc == HOST_FIND_AGAIN) return DEFER;
1898 *error = string_sprintf("failed to find IP address for %s", ss);
1902 /* Almost all subsequent comparisons require the host name, and can be done
1903 using the general string matching function. When this function is called for
1904 outgoing hosts, the name is always given explicitly. If it is NULL, it means we
1905 must use sender_host_name and its aliases, looking them up if necessary. */
1907 if (cb->host_name != NULL) /* Explicit host name given */
1908 return match_check_string(cb->host_name, ss, -1, TRUE, TRUE, TRUE,
1911 /* Host name not given; in principle we need the sender host name and its
1912 aliases. However, for query-style lookups, we do not need the name if the
1913 query does not contain $sender_host_name. From release 4.23, a reference to
1914 $sender_host_name causes it to be looked up, so we don't need to do the lookup
1917 if ((semicolon = Ustrchr(ss, ';')) != NULL)
1920 int partial, affixlen, starflags, id;
1923 id = search_findtype_partial(ss, &partial, &affix, &affixlen, &starflags);
1926 if (id < 0) /* Unknown lookup type */
1928 log_write(0, LOG_MAIN|LOG_PANIC, "%s in host list item \"%s\"",
1929 search_error_message, ss);
1932 isquery = mac_islookup(id, lookup_querystyle);
1937 switch(match_check_string(US"", ss, -1, TRUE, TRUE, TRUE, valueptr))
1940 case DEFER: return DEFER;
1941 default: return FAIL;
1945 /* Not a query-style lookup; must ensure the host name is present, and then we
1946 do a check on the name and all its aliases. */
1948 if (sender_host_name == NULL)
1950 HDEBUG(D_host_lookup)
1951 debug_printf("sender host name required, to match against %s\n", ss);
1952 if (host_lookup_failed || host_name_lookup() != OK)
1954 *error = string_sprintf("failed to find host name for %s",
1955 sender_host_address);;
1958 host_build_sender_fullhost();
1961 /* Match on the sender host name, using the general matching function */
1963 switch(match_check_string(sender_host_name, ss, -1, TRUE, TRUE, TRUE,
1967 case DEFER: return DEFER;
1970 /* If there are aliases, try matching on them. */
1972 aliases = sender_host_aliases;
1973 while (*aliases != NULL)
1975 switch(match_check_string(*aliases++, ss, -1, TRUE, TRUE, TRUE, valueptr))
1978 case DEFER: return DEFER;
1987 /*************************************************
1988 * Check a specific host matches a host list *
1989 *************************************************/
1991 /* This function is passed a host list containing items in a number of
1992 different formats and the identity of a host. Its job is to determine whether
1993 the given host is in the set of hosts defined by the list. The host name is
1994 passed as a pointer so that it can be looked up if needed and not already
1995 known. This is commonly the case when called from verify_check_host() to check
1996 an incoming connection. When called from elsewhere the host name should usually
1999 This function is now just a front end to match_check_list(), which runs common
2000 code for scanning a list. We pass it the check_host() function to perform a
2004 listptr pointer to the host list
2005 cache_bits pointer to cache for named lists, or NULL
2006 host_name the host name or NULL, implying use sender_host_name and
2007 sender_host_aliases, looking them up if required
2008 host_address the IP address
2009 valueptr if not NULL, data from a lookup is passed back here
2011 Returns: OK if the host is in the defined set
2012 FAIL if the host is not in the defined set,
2013 DEFER if a data lookup deferred (not a host lookup)
2015 If the host name was needed in order to make a comparison, and could not be
2016 determined from the IP address, the result is FAIL unless the item
2017 "+allow_unknown" was met earlier in the list, in which case OK is returned. */
2020 verify_check_this_host(uschar **listptr, unsigned int *cache_bits,
2021 uschar *host_name, uschar *host_address, uschar **valueptr)
2023 unsigned int *local_cache_bits = cache_bits;
2024 check_host_block cb;
2025 cb.host_name = host_name;
2026 cb.host_address = host_address;
2028 if (valueptr != NULL) *valueptr = NULL;
2030 /* If the host address starts off ::ffff: it is an IPv6 address in
2031 IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2034 cb.host_ipv4 = (Ustrncmp(host_address, "::ffff:", 7) == 0)?
2035 host_address + 7 : host_address;
2037 return match_check_list(listptr, 0, &hostlist_anchor, &local_cache_bits,
2038 check_host, &cb, MCL_HOST,
2039 (host_address == sender_host_address)? US"host" : host_address, valueptr);
2045 /*************************************************
2046 * Check the remote host matches a list *
2047 *************************************************/
2049 /* This is a front end to verify_check_this_host(), created because checking
2050 the remote host is a common occurrence. With luck, a good compiler will spot
2051 the tail recursion and optimize it. If there's no host address, this is
2052 command-line SMTP input - check against an empty string for the address.
2055 listptr pointer to the host list
2057 Returns: the yield of verify_check_this_host(),
2058 i.e. OK, FAIL, or DEFER
2062 verify_check_host(uschar **listptr)
2064 return verify_check_this_host(listptr, sender_host_cache, NULL,
2065 (sender_host_address == NULL)? US"" : sender_host_address, NULL);
2072 /*************************************************
2073 * Invert an IP address for a DNS black list *
2074 *************************************************/
2078 buffer where to put the answer
2079 address the address to invert
2083 invert_address(uschar *buffer, uschar *address)
2086 uschar *bptr = buffer;
2088 /* If this is an IPv4 address mapped into IPv6 format, adjust the pointer
2089 to the IPv4 part only. */
2091 if (Ustrncmp(address, "::ffff:", 7) == 0) address += 7;
2093 /* Handle IPv4 address: when HAVE_IPV6 is false, the result of host_aton() is
2096 if (host_aton(address, bin) == 1)
2100 for (i = 0; i < 4; i++)
2102 sprintf(CS bptr, "%d.", x & 255);
2103 while (*bptr) bptr++;
2108 /* Handle IPv6 address. Actually, as far as I know, there are no IPv6 addresses
2109 in any DNS black lists, and the format in which they will be looked up is
2110 unknown. This is just a guess. */
2116 for (j = 3; j >= 0; j--)
2119 for (i = 0; i < 8; i++)
2121 sprintf(CS bptr, "%x.", x & 15);
2122 while (*bptr) bptr++;
2132 /*************************************************
2133 * Check host against DNS black lists *
2134 *************************************************/
2136 /* This function runs checks against a list of DNS black lists, until one
2137 matches. Each item on the list can be of the form
2139 domain=ip-address/key
2141 The domain is the right-most domain that is used for the query, for example,
2142 blackholes.mail-abuse.org. If the IP address is present, there is a match only
2143 if the DNS lookup returns a matching IP address. Several addresses may be
2144 given, comma-separated, for example: x.y.z=127.0.0.1,127.0.0.2.
2146 If no key is given, what is looked up in the domain is the inverted IP address
2147 of the current client host. If a key is given, it is used to construct the
2148 domain for the lookup. For example,
2150 dsn.rfc-ignorant.org/$sender_address_domain
2152 After finding a match in the DNS, the domain is placed in $dnslist_domain, and
2153 then we check for a TXT record for an error message, and if found, save its
2154 value in $dnslist_text. We also cache everything in a tree, to optimize
2157 Note: an address for testing RBL is 192.203.178.39
2158 Note: an address for testing DUL is 192.203.178.4
2159 Note: a domain for testing RFCI is example.tld.dsn.rfc-ignorant.org
2162 listptr the domain/address/data list
2164 Returns: OK successful lookup (i.e. the address is on the list), or
2165 lookup deferred after +include_unknown
2166 FAIL name not found, or no data found for the given type, or
2167 lookup deferred after +exclude_unknown (default)
2168 DEFER lookup failure, if +defer_unknown was set
2172 verify_check_dnsbl(uschar **listptr)
2175 int defer_return = FAIL;
2176 int old_pool = store_pool;
2177 BOOL invert_result = FALSE;
2178 uschar *list = *listptr;
2181 uschar buffer[1024];
2182 uschar query[256]; /* DNS domain max length */
2183 uschar revadd[128]; /* Long enough for IPv6 address */
2185 /* Indicate that the inverted IP address is not yet set up */
2189 /* Loop through all the domains supplied, until something matches */
2191 while ((domain = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
2194 BOOL bitmask = FALSE;
2200 dnsbl_cache_block *cb;
2202 HDEBUG(D_dnsbl) debug_printf("DNS list check: %s\n", domain);
2204 /* Deal with special values that change the behaviour on defer */
2206 if (domain[0] == '+')
2208 if (strcmpic(domain, US"+include_unknown") == 0) defer_return = OK;
2209 else if (strcmpic(domain, US"+exclude_unknown") == 0) defer_return = FAIL;
2210 else if (strcmpic(domain, US"+defer_unknown") == 0) defer_return = DEFER;
2212 log_write(0, LOG_MAIN|LOG_PANIC, "unknown item in dnslist (ignored): %s",
2217 /* See if there's explicit data to be looked up */
2219 key = Ustrchr(domain, '/');
2220 if (key != NULL) *key++ = 0;
2222 /* See if there's a list of addresses supplied after the domain name. This is
2223 introduced by an = or a & character; if preceded by ! we invert the result.
2226 iplist = Ustrchr(domain, '=');
2230 iplist = Ustrchr(domain, '&');
2235 if (iplist > domain && iplist[-1] == '!')
2237 invert_result = TRUE;
2243 /* Check that what we have left is a sensible domain name. There is no reason
2244 why these domains should in fact use the same syntax as hosts and email
2245 domains, but in practice they seem to. However, there is little point in
2246 actually causing an error here, because that would no doubt hold up incoming
2247 mail. Instead, I'll just log it. */
2249 for (s = domain; *s != 0; s++)
2251 if (!isalnum(*s) && *s != '-' && *s != '.')
2253 log_write(0, LOG_MAIN, "dnslists domain \"%s\" contains "
2254 "strange characters - is this right?", domain);
2259 /* Construct the query by adding the domain onto either the sending host
2260 address, or the given key string. */
2264 if (sender_host_address == NULL) return FAIL; /* can never match */
2265 if (revadd[0] == 0) invert_address(revadd, sender_host_address);
2266 frc = string_format(query, sizeof(query), "%s%s", revadd, domain);
2270 frc = string_format(query, sizeof(query), "%s.%s", key, domain);
2275 log_write(0, LOG_MAIN|LOG_PANIC, "dnslist query is too long "
2276 "(ignored): %s...", query);
2280 /* Look for this query in the cache. */
2282 t = tree_search(dnsbl_cache, query);
2284 /* If not cached from a previous lookup, we must do a DNS lookup, and
2285 cache the result in permanent memory. */
2289 store_pool = POOL_PERM;
2291 /* In case this is the first time the DNS resolver is being used. */
2293 dns_init(FALSE, FALSE);
2295 /* Set up a tree entry to cache the lookup */
2297 t = store_get(sizeof(tree_node) + Ustrlen(query));
2298 Ustrcpy(t->name, query);
2299 t->data.ptr = cb = store_get(sizeof(dnsbl_cache_block));
2300 (void)tree_insertnode(&dnsbl_cache, t);
2302 /* Do the DNS loopup . */
2304 HDEBUG(D_dnsbl) debug_printf("new DNS lookup for %s\n", query);
2305 cb->rc = dns_basic_lookup(&dnsa, query, T_A);
2306 cb->text_set = FALSE;
2310 /* If the lookup succeeded, cache the RHS address. The code allows for
2311 more than one address - this was for complete generality and the possible
2312 use of A6 records. However, A6 records have been reduced to experimental
2313 status (August 2001) and may die out. So they may never get used at all,
2314 let alone in dnsbl records. However, leave the code here, just in case.
2316 Quite apart from one A6 RR generating multiple addresses, there are DNS
2317 lists that return more than one A record, so we must handle multiple
2318 addresses generated in that way as well. */
2320 if (cb->rc == DNS_SUCCEED)
2323 dns_address **addrp = &(cb->rhs);
2324 for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
2326 rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
2328 if (rr->type == T_A)
2330 dns_address *da = dns_address_from_rr(&dnsa, rr);
2334 while (da->next != NULL) da = da->next;
2335 addrp = &(da->next);
2340 /* If we didn't find any A records, change the return code. This can
2341 happen when there is a CNAME record but there are no A records for what
2344 if (cb->rhs == NULL) cb->rc = DNS_NODATA;
2347 store_pool = old_pool;
2350 /* Previous lookup was cached */
2354 HDEBUG(D_dnsbl) debug_printf("using result of previous DNS lookup\n");
2358 /* We now have the result of the DNS lookup, either newly done, or cached
2359 from a previous call. If the lookup succeeded, check against the address
2360 list if there is one. This may be a positive equality list (introduced by
2361 "="), a negative equality list (introduced by "!="), a positive bitmask
2362 list (introduced by "&"), or a negative bitmask list (introduced by "!&").*/
2364 if (cb->rc == DNS_SUCCEED)
2366 dns_address *da = NULL;
2367 uschar *addlist = cb->rhs->address;
2369 /* For A and AAAA records, there may be multiple addresses from multiple
2370 records. For A6 records (currently not expected to be used) there may be
2371 multiple addresses from a single record. */
2373 for (da = cb->rhs->next; da != NULL; da = da->next)
2374 addlist = string_sprintf("%s, %s", addlist, da->address);
2376 HDEBUG(D_dnsbl) debug_printf("DNS lookup for %s succeeded (yielding %s)\n",
2379 /* Address list check; this can be either for equality, or via a bitmask.
2380 In the latter case, all the bits must match. */
2386 uschar *ptr = iplist;
2388 while (string_nextinlist(&ptr, &ipsep, ip, sizeof(ip)) != NULL)
2390 /* Handle exact matching */
2393 for (da = cb->rhs; da != NULL; da = da->next)
2395 if (Ustrcmp(CS da->address, ip) == 0) break;
2398 /* Handle bitmask matching */
2404 /* At present, all known DNS blocking lists use A records, with
2405 IPv4 addresses on the RHS encoding the information they return. I
2406 wonder if this will linger on as the last vestige of IPv4 when IPv6
2407 is ubiquitous? Anyway, for now we use paranoia code to completely
2408 ignore IPv6 addresses. The default mask is 0, which always matches.
2409 We change this only for IPv4 addresses in the list. */
2411 if (host_aton(ip, address) == 1) mask = address[0];
2413 /* Scan the returned addresses, skipping any that are IPv6 */
2415 for (da = cb->rhs; da != NULL; da = da->next)
2417 if (host_aton(da->address, address) != 1) continue;
2418 if ((address[0] & mask) == mask) break;
2422 /* Break out if a match has been found */
2424 if (da != NULL) break;
2429 (a) No IP address in a positive list matched, or
2430 (b) An IP address in a negative list did match
2432 then behave as if the DNSBL lookup had not succeeded, i.e. the host is
2435 if (invert_result != (da == NULL))
2439 debug_printf("=> but we are not accepting this block class because\n");
2440 debug_printf("=> there was %s match for %c%s\n",
2441 invert_result? "an exclude":"no", bitmask? '&' : '=', iplist);
2443 continue; /* With next DNSBL domain */
2447 /* Either there was no IP list, or the record matched. Look up a TXT record
2448 if it hasn't previously been done. */
2452 cb->text_set = TRUE;
2453 if (dns_basic_lookup(&dnsa, query, T_TXT) == DNS_SUCCEED)
2456 for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
2458 rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
2459 if (rr->type == T_TXT) break;
2462 int len = (rr->data)[0];
2463 if (len > 511) len = 127;
2464 store_pool = POOL_PERM;
2465 cb->text = string_sprintf("%.*s", len, (const uschar *)(rr->data+1));
2466 store_pool = old_pool;
2473 debug_printf("=> that means %s is listed at %s\n",
2474 (key == NULL)? sender_host_address : key, domain);
2477 dnslist_domain = string_copy(domain);
2478 dnslist_value = addlist;
2479 dnslist_text = cb->text;
2483 /* There was a problem with the DNS lookup */
2485 if (cb->rc != DNS_NOMATCH && cb->rc != DNS_NODATA)
2487 log_write(L_dnslist_defer, LOG_MAIN,
2488 "DNS list lookup defer (probably timeout) for %s: %s", query,
2489 (defer_return == OK)? US"assumed in list" :
2490 (defer_return == FAIL)? US"assumed not in list" :
2491 US"returned DEFER");
2492 return defer_return;
2495 /* No entry was found in the DNS; continue for next domain */
2499 debug_printf("DNS lookup for %s failed\n", query);
2500 debug_printf("=> that means %s is not listed at %s\n",
2501 (key == NULL)? sender_host_address : key, domain);
2503 } /* Continue with next domain */
2508 /* End of verify.c */