Added $message_headers_raw to give all the headers without RFC 2047
[exim.git] / src / src / verify.c
CommitLineData
26da7e20 1/* $Cambridge: exim/src/src/verify.c,v 1.39 2006/09/25 11:25:37 ph10 Exp $ */
059ec3d9
PH
2
3/*************************************************
4* Exim - an Internet mail transport agent *
5*************************************************/
6
d7d7b7b9 7/* Copyright (c) University of Cambridge 1995 - 2006 */
059ec3d9
PH
8/* See the file NOTICE for conditions of use and distribution. */
9
10/* Functions concerned with verifying things. The original code for callout
11caching was contributed by Kevin Fleming (but I hacked it around a bit). */
12
13
14#include "exim.h"
15
16
17/* Structure for caching DNSBL lookups */
18
19typedef struct dnsbl_cache_block {
20 dns_address *rhs;
21 uschar *text;
22 int rc;
23 BOOL text_set;
24} dnsbl_cache_block;
25
26
27/* Anchor for DNSBL cache */
28
29static tree_node *dnsbl_cache = NULL;
30
31
32
33/*************************************************
34* Retrieve a callout cache record *
35*************************************************/
36
37/* If a record exists, check whether it has expired.
38
39Arguments:
40 dbm_file an open hints file
41 key the record key
42 type "address" or "domain"
43 positive_expire expire time for positive records
44 negative_expire expire time for negative records
45
46Returns: the cache record if a non-expired one exists, else NULL
47*/
48
49static dbdata_callout_cache *
50get_callout_cache_record(open_db *dbm_file, uschar *key, uschar *type,
51 int positive_expire, int negative_expire)
52{
53BOOL negative;
54int length, expire;
55time_t now;
56dbdata_callout_cache *cache_record;
57
58cache_record = dbfn_read_with_length(dbm_file, key, &length);
59
60if (cache_record == NULL)
61 {
62 HDEBUG(D_verify) debug_printf("callout cache: no %s record found\n", type);
63 return NULL;
64 }
65
66/* We treat a record as "negative" if its result field is not positive, or if
67it is a domain record and the postmaster field is negative. */
68
69negative = cache_record->result != ccache_accept ||
70 (type[0] == 'd' && cache_record->postmaster_result == ccache_reject);
71expire = negative? negative_expire : positive_expire;
72now = time(NULL);
73
74if (now - cache_record->time_stamp > expire)
75 {
76 HDEBUG(D_verify) debug_printf("callout cache: %s record expired\n", type);
77 return NULL;
78 }
79
80/* If this is a non-reject domain record, check for the obsolete format version
81that doesn't have the postmaster and random timestamps, by looking at the
82length. If so, copy it to a new-style block, replicating the record's
83timestamp. Then check the additional timestamps. (There's no point wasting
84effort if connections are rejected.) */
85
86if (type[0] == 'd' && cache_record->result != ccache_reject)
87 {
88 if (length == sizeof(dbdata_callout_cache_obs))
89 {
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;
93 cache_record = new;
94 }
95
96 if (now - cache_record->postmaster_stamp > expire)
97 cache_record->postmaster_result = ccache_unknown;
98
99 if (now - cache_record->random_stamp > expire)
100 cache_record->random_result = ccache_unknown;
101 }
102
103HDEBUG(D_verify) debug_printf("callout cache: found %s record\n", type);
104return cache_record;
105}
106
107
108
109/*************************************************
110* Do callout verification for an address *
111*************************************************/
112
113/* This function is called from verify_address() when the address has routed to
114a host list, and a callout has been requested. Callouts are expensive; that is
115why a cache is used to improve the efficiency.
116
117Arguments:
118 addr the address that's been routed
119 host_list the list of hosts to try
120 tf the transport feedback block
121
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
4deaf07d
PH
126 callout_overall the overall callout timeout (if < 0 use 4*callout)
127 callout_connect the callout connection timeout (if < 0 use callout)
059ec3d9
PH
128 options the verification options - these bits are used:
129 vopt_is_recipient => this is a recipient address
130 vopt_callout_no_cache => don't use callout cache
2a4be8f9 131 vopt_callout_fullpm => if postmaster check, do full one
059ec3d9
PH
132 vopt_callout_random => do the "random" thing
133 vopt_callout_recipsender => use real sender for recipient
134 vopt_callout_recippmaster => use postmaster for recipient
135 se_mailfrom MAIL FROM address for sender verify; NULL => ""
136 pm_mailfrom if non-NULL, do the postmaster check with this sender
137
138Returns: OK/FAIL/DEFER
139*/
140
141static int
142do_callout(address_item *addr, host_item *host_list, transport_feedback *tf,
8e669ac1 143 int callout, int callout_overall, int callout_connect, int options,
4deaf07d 144 uschar *se_mailfrom, uschar *pm_mailfrom)
059ec3d9
PH
145{
146BOOL is_recipient = (options & vopt_is_recipient) != 0;
147BOOL callout_no_cache = (options & vopt_callout_no_cache) != 0;
148BOOL callout_random = (options & vopt_callout_random) != 0;
149
150int yield = OK;
2b1c6e3a 151int old_domain_cache_result = ccache_accept;
059ec3d9
PH
152BOOL done = FALSE;
153uschar *address_key;
154uschar *from_address;
155uschar *random_local_part = NULL;
750af86e 156uschar *save_deliver_domain = deliver_domain;
8e669ac1 157uschar **failure_ptr = is_recipient?
2c7db3f5 158 &recipient_verify_failure : &sender_verify_failure;
059ec3d9
PH
159open_db dbblock;
160open_db *dbm_file = NULL;
161dbdata_callout_cache new_domain_record;
162dbdata_callout_cache_address new_address_record;
163host_item *host;
164time_t callout_start_time;
165
166new_domain_record.result = ccache_unknown;
167new_domain_record.postmaster_result = ccache_unknown;
168new_domain_record.random_result = ccache_unknown;
169
170memset(&new_address_record, 0, sizeof(new_address_record));
171
172/* For a recipient callout, the key used for the address cache record must
173include the sender address if we are using the real sender in the callout,
174because that may influence the result of the callout. */
175
176address_key = addr->address;
177from_address = US"";
178
179if (is_recipient)
180 {
181 if ((options & vopt_callout_recipsender) != 0)
182 {
183 address_key = string_sprintf("%s/<%s>", addr->address, sender_address);
184 from_address = sender_address;
185 }
186 else if ((options & vopt_callout_recippmaster) != 0)
187 {
188 address_key = string_sprintf("%s/<postmaster@%s>", addr->address,
189 qualify_domain_sender);
190 from_address = string_sprintf("postmaster@%s", qualify_domain_sender);
191 }
192 }
193
194/* For a sender callout, we must adjust the key if the mailfrom address is not
195empty. */
196
197else
198 {
199 from_address = (se_mailfrom == NULL)? US"" : se_mailfrom;
200 if (from_address[0] != 0)
201 address_key = string_sprintf("%s/<%s>", addr->address, from_address);
202 }
203
204/* Open the callout cache database, it it exists, for reading only at this
205stage, unless caching has been disabled. */
206
207if (callout_no_cache)
208 {
209 HDEBUG(D_verify) debug_printf("callout cache: disabled by no_cache\n");
210 }
211else if ((dbm_file = dbfn_open(US"callout", O_RDWR, &dbblock, FALSE)) == NULL)
212 {
213 HDEBUG(D_verify) debug_printf("callout cache: not available\n");
214 }
215
216/* If a cache database is available see if we can avoid the need to do an
217actual callout by making use of previously-obtained data. */
218
219if (dbm_file != NULL)
220 {
221 dbdata_callout_cache_address *cache_address_record;
222 dbdata_callout_cache *cache_record = get_callout_cache_record(dbm_file,
223 addr->domain, US"domain",
224 callout_cache_domain_positive_expire,
225 callout_cache_domain_negative_expire);
226
227 /* If an unexpired cache record was found for this domain, see if the callout
228 process can be short-circuited. */
229
230 if (cache_record != NULL)
231 {
2b1c6e3a
PH
232 /* In most cases, if an early command (up to and including MAIL FROM:<>)
233 was rejected, there is no point carrying on. The callout fails. However, if
234 we are doing a recipient verification with use_sender or use_postmaster
235 set, a previous failure of MAIL FROM:<> doesn't count, because this time we
236 will be using a non-empty sender. We have to remember this situation so as
237 not to disturb the cached domain value if this whole verification succeeds
238 (we don't want it turning into "accept"). */
239
240 old_domain_cache_result = cache_record->result;
241
242 if (cache_record->result == ccache_reject ||
243 (*from_address == 0 && cache_record->result == ccache_reject_mfnull))
059ec3d9
PH
244 {
245 setflag(addr, af_verify_nsfail);
246 HDEBUG(D_verify)
247 debug_printf("callout cache: domain gave initial rejection, or "
248 "does not accept HELO or MAIL FROM:<>\n");
249 setflag(addr, af_verify_nsfail);
250 addr->user_message = US"(result of an earlier callout reused).";
251 yield = FAIL;
8e669ac1 252 *failure_ptr = US"mail";
059ec3d9
PH
253 goto END_CALLOUT;
254 }
255
256 /* If a previous check on a "random" local part was accepted, we assume
257 that the server does not do any checking on local parts. There is therefore
258 no point in doing the callout, because it will always be successful. If a
259 random check previously failed, arrange not to do it again, but preserve
260 the data in the new record. If a random check is required but hasn't been
261 done, skip the remaining cache processing. */
262
263 if (callout_random) switch(cache_record->random_result)
264 {
265 case ccache_accept:
266 HDEBUG(D_verify)
267 debug_printf("callout cache: domain accepts random addresses\n");
268 goto END_CALLOUT; /* Default yield is OK */
269
270 case ccache_reject:
271 HDEBUG(D_verify)
272 debug_printf("callout cache: domain rejects random addresses\n");
273 callout_random = FALSE;
274 new_domain_record.random_result = ccache_reject;
275 new_domain_record.random_stamp = cache_record->random_stamp;
276 break;
277
278 default:
279 HDEBUG(D_verify)
280 debug_printf("callout cache: need to check random address handling "
281 "(not cached or cache expired)\n");
282 goto END_CACHE;
283 }
284
285 /* If a postmaster check is requested, but there was a previous failure,
286 there is again no point in carrying on. If a postmaster check is required,
287 but has not been done before, we are going to have to do a callout, so skip
288 remaining cache processing. */
289
290 if (pm_mailfrom != NULL)
291 {
292 if (cache_record->postmaster_result == ccache_reject)
293 {
294 setflag(addr, af_verify_pmfail);
295 HDEBUG(D_verify)
296 debug_printf("callout cache: domain does not accept "
297 "RCPT TO:<postmaster@domain>\n");
298 yield = FAIL;
8e669ac1 299 *failure_ptr = US"postmaster";
059ec3d9
PH
300 setflag(addr, af_verify_pmfail);
301 addr->user_message = US"(result of earlier verification reused).";
302 goto END_CALLOUT;
303 }
304 if (cache_record->postmaster_result == ccache_unknown)
305 {
306 HDEBUG(D_verify)
307 debug_printf("callout cache: need to check RCPT "
308 "TO:<postmaster@domain> (not cached or cache expired)\n");
309 goto END_CACHE;
310 }
311
312 /* If cache says OK, set pm_mailfrom NULL to prevent a redundant
313 postmaster check if the address itself has to be checked. Also ensure
314 that the value in the cache record is preserved (with its old timestamp).
315 */
316
317 HDEBUG(D_verify) debug_printf("callout cache: domain accepts RCPT "
318 "TO:<postmaster@domain>\n");
319 pm_mailfrom = NULL;
320 new_domain_record.postmaster_result = ccache_accept;
321 new_domain_record.postmaster_stamp = cache_record->postmaster_stamp;
322 }
323 }
324
325 /* We can't give a result based on information about the domain. See if there
326 is an unexpired cache record for this specific address (combined with the
327 sender address if we are doing a recipient callout with a non-empty sender).
328 */
329
330 cache_address_record = (dbdata_callout_cache_address *)
331 get_callout_cache_record(dbm_file,
332 address_key, US"address",
333 callout_cache_positive_expire,
334 callout_cache_negative_expire);
335
336 if (cache_address_record != NULL)
337 {
338 if (cache_address_record->result == ccache_accept)
339 {
340 HDEBUG(D_verify)
341 debug_printf("callout cache: address record is positive\n");
342 }
343 else
344 {
345 HDEBUG(D_verify)
346 debug_printf("callout cache: address record is negative\n");
347 addr->user_message = US"Previous (cached) callout verification failure";
8e669ac1 348 *failure_ptr = US"recipient";
059ec3d9
PH
349 yield = FAIL;
350 }
351 goto END_CALLOUT;
352 }
353
354 /* Close the cache database while we actually do the callout for real. */
355
356 END_CACHE:
357 dbfn_close(dbm_file);
358 dbm_file = NULL;
359 }
360
361/* The information wasn't available in the cache, so we have to do a real
362callout and save the result in the cache for next time, unless no_cache is set,
363or unless we have a previously cached negative random result. If we are to test
364with a random local part, ensure that such a local part is available. If not,
365log the fact, but carry on without randomming. */
366
367if (callout_random && callout_random_local_part != NULL)
368 {
369 random_local_part = expand_string(callout_random_local_part);
370 if (random_local_part == NULL)
371 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand "
372 "callout_random_local_part: %s", expand_string_message);
373 }
374
4deaf07d
PH
375/* Default the connect and overall callout timeouts if not set, and record the
376time we are starting so that we can enforce it. */
059ec3d9
PH
377
378if (callout_overall < 0) callout_overall = 4 * callout;
4deaf07d 379if (callout_connect < 0) callout_connect = callout;
059ec3d9
PH
380callout_start_time = time(NULL);
381
382/* Now make connections to the hosts and do real callouts. The list of hosts
383is passed in as an argument. */
384
385for (host = host_list; host != NULL && !done; host = host->next)
386 {
387 smtp_inblock inblock;
388 smtp_outblock outblock;
389 int host_af;
390 int port = 25;
8e669ac1 391 BOOL send_quit = TRUE;
26da7e20 392 uschar *active_hostname = smtp_active_hostname;
059ec3d9
PH
393 uschar *helo = US"HELO";
394 uschar *interface = NULL; /* Outgoing interface to use; NULL => any */
395 uschar inbuffer[4096];
396 uschar outbuffer[1024];
397 uschar responsebuffer[4096];
398
399 clearflag(addr, af_verify_pmfail); /* postmaster callout flag */
400 clearflag(addr, af_verify_nsfail); /* null sender callout flag */
401
402 /* Skip this host if we don't have an IP address for it. */
403
404 if (host->address == NULL)
405 {
406 DEBUG(D_verify) debug_printf("no IP address for host name %s: skipping\n",
407 host->name);
408 continue;
409 }
410
411 /* Check the overall callout timeout */
412
413 if (time(NULL) - callout_start_time >= callout_overall)
414 {
415 HDEBUG(D_verify) debug_printf("overall timeout for callout exceeded\n");
416 break;
417 }
418
419 /* Set IPv4 or IPv6 */
420
421 host_af = (Ustrchr(host->address, ':') == NULL)? AF_INET:AF_INET6;
422
de3a88fb
PH
423 /* Expand and interpret the interface and port strings. The latter will not
424 be used if there is a host-specific port (e.g. from a manualroute router).
425 This has to be delayed till now, because they may expand differently for
426 different hosts. If there's a failure, log it, but carry on with the
427 defaults. */
059ec3d9
PH
428
429 deliver_host = host->name;
430 deliver_host_address = host->address;
750af86e 431 deliver_domain = addr->domain;
de3a88fb 432
059ec3d9
PH
433 if (!smtp_get_interface(tf->interface, host_af, addr, NULL, &interface,
434 US"callout") ||
435 !smtp_get_port(tf->port, addr, &port, US"callout"))
436 log_write(0, LOG_MAIN|LOG_PANIC, "<%s>: %s", addr->address,
437 addr->message);
de3a88fb 438
26da7e20
PH
439 /* Expand the helo_data string to find the host name to use. */
440
441 if (tf->helo_data != NULL)
442 {
443 uschar *s = expand_string(tf->helo_data);
444 if (active_hostname == NULL)
445 log_write(0, LOG_MAIN|LOG_PANIC, "<%s>: failed to expand transport's "
446 "helo_data value for callout: %s", expand_string_message);
447 else active_hostname = s;
448 }
449
059ec3d9 450 deliver_host = deliver_host_address = NULL;
750af86e 451 deliver_domain = save_deliver_domain;
059ec3d9
PH
452
453 /* Set HELO string according to the protocol */
454
455 if (Ustrcmp(tf->protocol, "lmtp") == 0) helo = US"LHLO";
456
457 HDEBUG(D_verify) debug_printf("interface=%s port=%d\n", interface, port);
458
459 /* Set up the buffer for reading SMTP response packets. */
460
461 inblock.buffer = inbuffer;
462 inblock.buffersize = sizeof(inbuffer);
463 inblock.ptr = inbuffer;
464 inblock.ptrend = inbuffer;
465
466 /* Set up the buffer for holding SMTP commands while pipelining */
467
468 outblock.buffer = outbuffer;
469 outblock.buffersize = sizeof(outbuffer);
470 outblock.ptr = outbuffer;
471 outblock.cmd_count = 0;
472 outblock.authenticating = FALSE;
473
474 /* Connect to the host; on failure, just loop for the next one, but we
4deaf07d 475 set the error for the last one. Use the callout_connect timeout. */
059ec3d9
PH
476
477 inblock.sock = outblock.sock =
4deaf07d 478 smtp_connect(host, host_af, port, interface, callout_connect, TRUE);
059ec3d9
PH
479 if (inblock.sock < 0)
480 {
481 addr->message = string_sprintf("could not connect to %s [%s]: %s",
482 host->name, host->address, strerror(errno));
483 continue;
484 }
485
2b1c6e3a
PH
486 /* Wait for initial response, and send HELO. The smtp_write_command()
487 function leaves its command in big_buffer. This is used in error responses.
488 Initialize it in case the connection is rejected. */
059ec3d9
PH
489
490 Ustrcpy(big_buffer, "initial connection");
491
492 done =
493 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
494 '2', callout) &&
059ec3d9 495 smtp_write_command(&outblock, FALSE, "%s %s\r\n", helo,
26da7e20 496 active_hostname) >= 0 &&
059ec3d9 497 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
2b1c6e3a 498 '2', callout);
059ec3d9 499
2b1c6e3a
PH
500 /* Failure to accept HELO is cached; this blocks the whole domain for all
501 senders. I/O errors and defer responses are not cached. */
502
503 if (!done)
504 {
505 *failure_ptr = US"mail"; /* At or before MAIL */
506 if (errno == 0 && responsebuffer[0] == '5')
507 {
508 setflag(addr, af_verify_nsfail);
509 new_domain_record.result = ccache_reject;
510 }
511 }
512
513 /* Send the MAIL command */
514
515 else done =
059ec3d9
PH
516 smtp_write_command(&outblock, FALSE, "MAIL FROM:<%s>\r\n",
517 from_address) >= 0 &&
518 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
519 '2', callout);
520
2b1c6e3a
PH
521 /* If the host does not accept MAIL FROM:<>, arrange to cache this
522 information, but again, don't record anything for an I/O error or a defer. Do
523 not cache rejections of MAIL when a non-empty sender has been used, because
524 that blocks the whole domain for all senders. */
059ec3d9
PH
525
526 if (!done)
527 {
2b1c6e3a 528 *failure_ptr = US"mail"; /* At or before MAIL */
059ec3d9
PH
529 if (errno == 0 && responsebuffer[0] == '5')
530 {
531 setflag(addr, af_verify_nsfail);
2b1c6e3a
PH
532 if (from_address[0] == 0)
533 new_domain_record.result = ccache_reject_mfnull;
059ec3d9
PH
534 }
535 }
536
537 /* Otherwise, proceed to check a "random" address (if required), then the
538 given address, and the postmaster address (if required). Between each check,
539 issue RSET, because some servers accept only one recipient after MAIL
2b1c6e3a
PH
540 FROM:<>.
541
542 Before doing this, set the result in the domain cache record to "accept",
543 unless its previous value was ccache_reject_mfnull. In that case, the domain
544 rejects MAIL FROM:<> and we want to continue to remember that. When that is
545 the case, we have got here only in the case of a recipient verification with
546 a non-null sender. */
059ec3d9
PH
547
548 else
549 {
2b1c6e3a
PH
550 new_domain_record.result =
551 (old_domain_cache_result == ccache_reject_mfnull)?
552 ccache_reject_mfnull: ccache_accept;
059ec3d9
PH
553
554 /* Do the random local part check first */
555
556 if (random_local_part != NULL)
557 {
558 uschar randombuffer[1024];
559 BOOL random_ok =
560 smtp_write_command(&outblock, FALSE,
561 "RCPT TO:<%.1000s@%.1000s>\r\n", random_local_part,
562 addr->domain) >= 0 &&
563 smtp_read_response(&inblock, randombuffer,
564 sizeof(randombuffer), '2', callout);
565
566 /* Remember when we last did a random test */
567
568 new_domain_record.random_stamp = time(NULL);
569
570 /* If accepted, we aren't going to do any further tests below. */
571
572 if (random_ok)
573 {
574 new_domain_record.random_result = ccache_accept;
575 }
576
577 /* Otherwise, cache a real negative response, and get back to the right
578 state to send RCPT. Unless there's some problem such as a dropped
579 connection, we expect to succeed, because the commands succeeded above. */
580
581 else if (errno == 0)
582 {
583 if (randombuffer[0] == '5')
584 new_domain_record.random_result = ccache_reject;
585
586 done =
587 smtp_write_command(&outblock, FALSE, "RSET\r\n") >= 0 &&
588 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
589 '2', callout) &&
590
90e9ce59
PH
591 smtp_write_command(&outblock, FALSE, "MAIL FROM:<%s>\r\n",
592 from_address) >= 0 &&
059ec3d9
PH
593 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
594 '2', callout);
595 }
596 else done = FALSE; /* Some timeout/connection problem */
597 } /* Random check */
598
599 /* If the host is accepting all local parts, as determined by the "random"
600 check, we don't need to waste time doing any further checking. */
601
602 if (new_domain_record.random_result != ccache_accept && done)
603 {
5417f6d1
PH
604 /* Get the rcpt_include_affixes flag from the transport if there is one,
605 but assume FALSE if there is not. */
606
059ec3d9
PH
607 done =
608 smtp_write_command(&outblock, FALSE, "RCPT TO:<%.1000s>\r\n",
c688b954 609 transport_rcpt_address(addr,
5417f6d1
PH
610 (addr->transport == NULL)? FALSE :
611 addr->transport->rcpt_include_affixes)) >= 0 &&
059ec3d9
PH
612 smtp_read_response(&inblock, responsebuffer, sizeof(responsebuffer),
613 '2', callout);
614
615 if (done)
616 new_address_record.result = ccache_accept;
617 else if (errno == 0 && responsebuffer[0] == '5')
2c7db3f5 618 {
8e669ac1 619 *failure_ptr = US"recipient";
059ec3d9 620 new_address_record.result = ccache_reject;
8e669ac1 621 }
059ec3d9 622
2a4be8f9
PH
623 /* Do postmaster check if requested; if a full check is required, we
624 check for RCPT TO:<postmaster> (no domain) in accordance with RFC 821. */
059ec3d9
PH
625
626 if (done && pm_mailfrom != NULL)
627 {
628 done =
629 smtp_write_command(&outblock, FALSE, "RSET\r\n") >= 0 &&
630 smtp_read_response(&inblock, responsebuffer,
631 sizeof(responsebuffer), '2', callout) &&
632
633 smtp_write_command(&outblock, FALSE,
634 "MAIL FROM:<%s>\r\n", pm_mailfrom) >= 0 &&
635 smtp_read_response(&inblock, responsebuffer,
636 sizeof(responsebuffer), '2', callout) &&
637
2a4be8f9
PH
638 /* First try using the current domain */
639
640 ((
059ec3d9
PH
641 smtp_write_command(&outblock, FALSE,
642 "RCPT TO:<postmaster@%.1000s>\r\n", addr->domain) >= 0 &&
643 smtp_read_response(&inblock, responsebuffer,
2a4be8f9
PH
644 sizeof(responsebuffer), '2', callout)
645 )
646
647 ||
648
649 /* If that doesn't work, and a full check is requested,
650 try without the domain. */
651
652 (
653 (options & vopt_callout_fullpm) != 0 &&
654 smtp_write_command(&outblock, FALSE,
655 "RCPT TO:<postmaster>\r\n") >= 0 &&
656 smtp_read_response(&inblock, responsebuffer,
657 sizeof(responsebuffer), '2', callout)
658 ));
659
660 /* Sort out the cache record */
059ec3d9
PH
661
662 new_domain_record.postmaster_stamp = time(NULL);
663
664 if (done)
665 new_domain_record.postmaster_result = ccache_accept;
666 else if (errno == 0 && responsebuffer[0] == '5')
667 {
8e669ac1 668 *failure_ptr = US"postmaster";
059ec3d9
PH
669 setflag(addr, af_verify_pmfail);
670 new_domain_record.postmaster_result = ccache_reject;
671 }
672 }
673 } /* Random not accepted */
90e9ce59 674 } /* MAIL FROM: accepted */
059ec3d9
PH
675
676 /* For any failure of the main check, other than a negative response, we just
677 close the connection and carry on. We can identify a negative response by the
678 fact that errno is zero. For I/O errors it will be non-zero
679
680 Set up different error texts for logging and for sending back to the caller
681 as an SMTP response. Log in all cases, using a one-line format. For sender
682 callouts, give a full response to the caller, but for recipient callouts,
683 don't give the IP address because this may be an internal host whose identity
684 is not to be widely broadcast. */
685
686 if (!done)
687 {
688 if (errno == ETIMEDOUT)
689 {
690 HDEBUG(D_verify) debug_printf("SMTP timeout\n");
8e669ac1 691 send_quit = FALSE;
059ec3d9
PH
692 }
693 else if (errno == 0)
694 {
695 if (*responsebuffer == 0) Ustrcpy(responsebuffer, US"connection dropped");
696
697 addr->message =
698 string_sprintf("response to \"%s\" from %s [%s] was: %s",
699 big_buffer, host->name, host->address,
700 string_printing(responsebuffer));
701
702 addr->user_message = is_recipient?
703 string_sprintf("Callout verification failed:\n%s", responsebuffer)
704 :
705 string_sprintf("Called: %s\nSent: %s\nResponse: %s",
706 host->address, big_buffer, responsebuffer);
707
708 /* Hard rejection ends the process */
709
710 if (responsebuffer[0] == '5') /* Address rejected */
711 {
712 yield = FAIL;
713 done = TRUE;
714 }
715 }
716 }
717
718 /* End the SMTP conversation and close the connection. */
719
c9bdd01c 720 if (send_quit) (void)smtp_write_command(&outblock, FALSE, "QUIT\r\n");
f1e894f3 721 (void)close(inblock.sock);
059ec3d9
PH
722 } /* Loop through all hosts, while !done */
723
724/* If we get here with done == TRUE, a successful callout happened, and yield
725will be set OK or FAIL according to the response to the RCPT command.
726Otherwise, we looped through the hosts but couldn't complete the business.
727However, there may be domain-specific information to cache in both cases.
728
729The value of the result field in the new_domain record is ccache_unknown if
90e9ce59 730there was an error before or with MAIL FROM:, and errno was not zero,
059ec3d9 731implying some kind of I/O error. We don't want to write the cache in that case.
2b1c6e3a 732Otherwise the value is ccache_accept, ccache_reject, or ccache_reject_mfnull. */
059ec3d9
PH
733
734if (!callout_no_cache && new_domain_record.result != ccache_unknown)
735 {
736 if ((dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE))
737 == NULL)
738 {
739 HDEBUG(D_verify) debug_printf("callout cache: not available\n");
740 }
741 else
742 {
743 (void)dbfn_write(dbm_file, addr->domain, &new_domain_record,
744 (int)sizeof(dbdata_callout_cache));
745 HDEBUG(D_verify) debug_printf("wrote callout cache domain record:\n"
746 " result=%d postmaster=%d random=%d\n",
747 new_domain_record.result,
748 new_domain_record.postmaster_result,
749 new_domain_record.random_result);
750 }
751 }
752
753/* If a definite result was obtained for the callout, cache it unless caching
754is disabled. */
755
756if (done)
757 {
758 if (!callout_no_cache && new_address_record.result != ccache_unknown)
759 {
760 if (dbm_file == NULL)
761 dbm_file = dbfn_open(US"callout", O_RDWR|O_CREAT, &dbblock, FALSE);
762 if (dbm_file == NULL)
763 {
764 HDEBUG(D_verify) debug_printf("no callout cache available\n");
765 }
766 else
767 {
768 (void)dbfn_write(dbm_file, address_key, &new_address_record,
769 (int)sizeof(dbdata_callout_cache_address));
770 HDEBUG(D_verify) debug_printf("wrote %s callout cache address record\n",
771 (new_address_record.result == ccache_accept)? "positive" : "negative");
772 }
773 }
774 } /* done */
775
776/* Failure to connect to any host, or any response other than 2xx or 5xx is a
777temporary error. If there was only one host, and a response was received, leave
778it alone if supplying details. Otherwise, give a generic response. */
779
780else /* !done */
781 {
782 uschar *dullmsg = string_sprintf("Could not complete %s verify callout",
783 is_recipient? "recipient" : "sender");
784 yield = DEFER;
785
786 if (host_list->next != NULL || addr->message == NULL) addr->message = dullmsg;
787
788 addr->user_message = (!smtp_return_error_details)? dullmsg :
789 string_sprintf("%s for <%s>.\n"
790 "The mail server(s) for the domain may be temporarily unreachable, or\n"
791 "they may be permanently unreachable from this server. In the latter case,\n%s",
792 dullmsg, addr->address,
793 is_recipient?
794 "the address will never be accepted."
795 :
796 "you need to change the address or create an MX record for its domain\n"
797 "if it is supposed to be generally accessible from the Internet.\n"
798 "Talk to your mail administrator for details.");
799
800 /* Force a specific error code */
801
802 addr->basic_errno = ERRNO_CALLOUTDEFER;
803 }
804
805/* Come here from within the cache-reading code on fast-track exit. */
806
807END_CALLOUT:
808if (dbm_file != NULL) dbfn_close(dbm_file);
809return yield;
810}
811
812
813
814/*************************************************
815* Copy error to toplevel address *
816*************************************************/
817
818/* This function is used when a verify fails or defers, to ensure that the
819failure or defer information is in the original toplevel address. This applies
820when an address is redirected to a single new address, and the failure or
821deferral happens to the child address.
822
823Arguments:
824 vaddr the verify address item
825 addr the final address item
826 yield FAIL or DEFER
827
828Returns: the value of YIELD
829*/
830
831static int
832copy_error(address_item *vaddr, address_item *addr, int yield)
833{
834if (addr != vaddr)
835 {
836 vaddr->message = addr->message;
837 vaddr->user_message = addr->user_message;
838 vaddr->basic_errno = addr->basic_errno;
839 vaddr->more_errno = addr->more_errno;
b37c4101 840 vaddr->p.address_data = addr->p.address_data;
059ec3d9
PH
841 }
842return yield;
843}
844
845
846
847
848/*************************************************
849* Verify an email address *
850*************************************************/
851
852/* This function is used both for verification (-bv and at other times) and
853address testing (-bt), which is indicated by address_test_mode being set.
854
855Arguments:
856 vaddr contains the address to verify; the next field in this block
857 must be NULL
858 f if not NULL, write the result to this file
859 options various option bits:
860 vopt_fake_sender => this sender verify is not for the real
861 sender (it was verify=sender=xxxx or an address from a
862 header line) - rewriting must not change sender_address
863 vopt_is_recipient => this is a recipient address, otherwise
864 it's a sender address - this affects qualification and
865 rewriting and messages from callouts
866 vopt_qualify => qualify an unqualified address; else error
867 vopt_expn => called from SMTP EXPN command
eafd343b
TK
868 vopt_success_on_redirect => when a new address is generated
869 the verification instantly succeeds
059ec3d9
PH
870
871 These ones are used by do_callout() -- the options variable
872 is passed to it.
873
2a4be8f9 874 vopt_callout_fullpm => if postmaster check, do full one
059ec3d9
PH
875 vopt_callout_no_cache => don't use callout cache
876 vopt_callout_random => do the "random" thing
877 vopt_callout_recipsender => use real sender for recipient
878 vopt_callout_recippmaster => use postmaster for recipient
879
880 callout if > 0, specifies that callout is required, and gives timeout
4deaf07d 881 for individual commands
059ec3d9
PH
882 callout_overall if > 0, gives overall timeout for the callout function;
883 if < 0, a default is used (see do_callout())
8e669ac1 884 callout_connect the connection timeout for callouts
059ec3d9
PH
885 se_mailfrom when callout is requested to verify a sender, use this
886 in MAIL FROM; NULL => ""
887 pm_mailfrom when callout is requested, if non-NULL, do the postmaster
888 thing and use this as the sender address (may be "")
889
890 routed if not NULL, set TRUE if routing succeeded, so we can
891 distinguish between routing failed and callout failed
892
893Returns: OK address verified
894 FAIL address failed to verify
895 DEFER can't tell at present
896*/
897
898int
899verify_address(address_item *vaddr, FILE *f, int options, int callout,
8e669ac1 900 int callout_overall, int callout_connect, uschar *se_mailfrom,
4deaf07d 901 uschar *pm_mailfrom, BOOL *routed)
059ec3d9
PH
902{
903BOOL allok = TRUE;
904BOOL full_info = (f == NULL)? FALSE : (debug_selector != 0);
905BOOL is_recipient = (options & vopt_is_recipient) != 0;
906BOOL expn = (options & vopt_expn) != 0;
eafd343b 907BOOL success_on_redirect = (options & vopt_success_on_redirect) != 0;
059ec3d9
PH
908int i;
909int yield = OK;
910int verify_type = expn? v_expn :
911 address_test_mode? v_none :
912 is_recipient? v_recipient : v_sender;
913address_item *addr_list;
914address_item *addr_new = NULL;
915address_item *addr_remote = NULL;
916address_item *addr_local = NULL;
917address_item *addr_succeed = NULL;
8e669ac1 918uschar **failure_ptr = is_recipient?
2c7db3f5 919 &recipient_verify_failure : &sender_verify_failure;
059ec3d9
PH
920uschar *ko_prefix, *cr;
921uschar *address = vaddr->address;
922uschar *save_sender;
923uschar null_sender[] = { 0 }; /* Ensure writeable memory */
924
2c7db3f5
PH
925/* Clear, just in case */
926
927*failure_ptr = NULL;
928
059ec3d9
PH
929/* Set up a prefix and suffix for error message which allow us to use the same
930output statements both in EXPN mode (where an SMTP response is needed) and when
931debugging with an output file. */
932
933if (expn)
934 {
935 ko_prefix = US"553 ";
936 cr = US"\r";
937 }
938else ko_prefix = cr = US"";
939
940/* Add qualify domain if permitted; otherwise an unqualified address fails. */
941
942if (parse_find_at(address) == NULL)
943 {
944 if ((options & vopt_qualify) == 0)
945 {
946 if (f != NULL)
947 fprintf(f, "%sA domain is required for \"%s\"%s\n", ko_prefix, address,
948 cr);
8e669ac1 949 *failure_ptr = US"qualify";
059ec3d9
PH
950 return FAIL;
951 }
952 address = rewrite_address_qualify(address, is_recipient);
953 }
954
955DEBUG(D_verify)
956 {
957 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
958 debug_printf("%s %s\n", address_test_mode? "Testing" : "Verifying", address);
959 }
960
961/* Rewrite and report on it. Clear the domain and local part caches - these
962may have been set by domains and local part tests during an ACL. */
963
964if (global_rewrite_rules != NULL)
965 {
966 uschar *old = address;
967 address = rewrite_address(address, is_recipient, FALSE,
968 global_rewrite_rules, rewrite_existflags);
969 if (address != old)
970 {
971 for (i = 0; i < (MAX_NAMED_LIST * 2)/32; i++) vaddr->localpart_cache[i] = 0;
972 for (i = 0; i < (MAX_NAMED_LIST * 2)/32; i++) vaddr->domain_cache[i] = 0;
973 if (f != NULL && !expn) fprintf(f, "Address rewritten as: %s\n", address);
974 }
975 }
976
977/* If this is the real sender address, we must update sender_address at
978this point, because it may be referred to in the routers. */
979
980if ((options & (vopt_fake_sender|vopt_is_recipient)) == 0)
981 sender_address = address;
982
983/* If the address was rewritten to <> no verification can be done, and we have
984to return OK. This rewriting is permitted only for sender addresses; for other
985addresses, such rewriting fails. */
986
987if (address[0] == 0) return OK;
988
989/* Save a copy of the sender address for re-instating if we change it to <>
990while verifying a sender address (a nice bit of self-reference there). */
991
992save_sender = sender_address;
993
994/* Update the address structure with the possibly qualified and rewritten
995address. Set it up as the starting address on the chain of new addresses. */
996
997vaddr->address = address;
998addr_new = vaddr;
999
1000/* We need a loop, because an address can generate new addresses. We must also
1001cope with generated pipes and files at the top level. (See also the code and
1002comment in deliver.c.) However, it is usually the case that the router for
1003user's .forward files has its verify flag turned off.
1004
1005If an address generates more than one child, the loop is used only when
1006full_info is set, and this can only be set locally. Remote enquiries just get
1007information about the top level address, not anything that it generated. */
1008
1009while (addr_new != NULL)
1010 {
1011 int rc;
1012 address_item *addr = addr_new;
1013
1014 addr_new = addr->next;
1015 addr->next = NULL;
1016
1017 DEBUG(D_verify)
1018 {
1019 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
1020 debug_printf("Considering %s\n", addr->address);
1021 }
1022
1023 /* Handle generated pipe, file or reply addresses. We don't get these
1024 when handling EXPN, as it does only one level of expansion. */
1025
1026 if (testflag(addr, af_pfr))
1027 {
1028 allok = FALSE;
1029 if (f != NULL)
1030 {
1031 BOOL allow;
1032
1033 if (addr->address[0] == '>')
1034 {
1035 allow = testflag(addr, af_allow_reply);
1036 fprintf(f, "%s -> mail %s", addr->parent->address, addr->address + 1);
1037 }
1038 else
1039 {
1040 allow = (addr->address[0] == '|')?
1041 testflag(addr, af_allow_pipe) : testflag(addr, af_allow_file);
1042 fprintf(f, "%s -> %s", addr->parent->address, addr->address);
1043 }
1044
1045 if (addr->basic_errno == ERRNO_BADTRANSPORT)
1046 fprintf(f, "\n*** Error in setting up pipe, file, or autoreply:\n"
1047 "%s\n", addr->message);
1048 else if (allow)
1049 fprintf(f, "\n transport = %s\n", addr->transport->name);
1050 else
1051 fprintf(f, " *** forbidden ***\n");
1052 }
1053 continue;
1054 }
1055
1056 /* Just in case some router parameter refers to it. */
1057
1058 return_path = (addr->p.errors_address != NULL)?
1059 addr->p.errors_address : sender_address;
1060
1061 /* Split the address into domain and local part, handling the %-hack if
1062 necessary, and then route it. While routing a sender address, set
1063 $sender_address to <> because that is what it will be if we were trying to
1064 send a bounce to the sender. */
1065
1066 if (routed != NULL) *routed = FALSE;
1067 if ((rc = deliver_split_address(addr)) == OK)
1068 {
1069 if (!is_recipient) sender_address = null_sender;
1070 rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
1071 &addr_succeed, verify_type);
1072 sender_address = save_sender; /* Put back the real sender */
1073 }
1074
1075 /* If routing an address succeeded, set the flag that remembers, for use when
1076 an ACL cached a sender verify (in case a callout fails). Then if routing set
1077 up a list of hosts or the transport has a host list, and the callout option
1078 is set, and we aren't in a host checking run, do the callout verification,
1079 and set another flag that notes that a callout happened. */
1080
1081 if (rc == OK)
1082 {
1083 if (routed != NULL) *routed = TRUE;
1084 if (callout > 0)
1085 {
1086 host_item *host_list = addr->host_list;
1087
26da7e20
PH
1088 /* Make up some data for use in the case where there is no remote
1089 transport. */
1090
1091 transport_feedback tf = {
1092 NULL, /* interface (=> any) */
1093 US"smtp", /* port */
1094 US"smtp", /* protocol */
1095 NULL, /* hosts */
1096 US"$smtp_active_hostname", /* helo_data */
1097 FALSE, /* hosts_override */
1098 FALSE, /* hosts_randomize */
1099 FALSE, /* gethostbyname */
1100 TRUE, /* qualify_single */
1101 FALSE /* search_parents */
1102 };
059ec3d9
PH
1103
1104 /* If verification yielded a remote transport, we want to use that
1105 transport's options, so as to mimic what would happen if we were really
1106 sending a message to this address. */
1107
1108 if (addr->transport != NULL && !addr->transport->info->local)
1109 {
929ba01c 1110 (void)(addr->transport->setup)(addr->transport, addr, &tf, 0, 0, NULL);
059ec3d9
PH
1111
1112 /* If the transport has hosts and the router does not, or if the
1113 transport is configured to override the router's hosts, we must build a
1114 host list of the transport's hosts, and find the IP addresses */
1115
1116 if (tf.hosts != NULL && (host_list == NULL || tf.hosts_override))
1117 {
1118 uschar *s;
750af86e
PH
1119 uschar *save_deliver_domain = deliver_domain;
1120 uschar *save_deliver_localpart = deliver_localpart;
059ec3d9
PH
1121
1122 host_list = NULL; /* Ignore the router's hosts */
1123
1124 deliver_domain = addr->domain;
1125 deliver_localpart = addr->local_part;
1126 s = expand_string(tf.hosts);
750af86e
PH
1127 deliver_domain = save_deliver_domain;
1128 deliver_localpart = save_deliver_localpart;
059ec3d9
PH
1129
1130 if (s == NULL)
1131 {
1132 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand list of hosts "
1133 "\"%s\" in %s transport for callout: %s", tf.hosts,
1134 addr->transport->name, expand_string_message);
1135 }
1136 else
1137 {
1138 uschar *canonical_name;
d8ef3577 1139 host_item *host, *nexthost;
059ec3d9
PH
1140 host_build_hostlist(&host_list, s, tf.hosts_randomize);
1141
1142 /* Just ignore failures to find a host address. If we don't manage
8e669ac1
PH
1143 to find any addresses, the callout will defer. Note that more than
1144 one address may be found for a single host, which will result in
1145 additional host items being inserted into the chain. Hence we must
d8ef3577 1146 save the next host first. */
059ec3d9 1147
d8ef3577 1148 for (host = host_list; host != NULL; host = nexthost)
059ec3d9 1149 {
d8ef3577 1150 nexthost = host->next;
8e669ac1 1151 if (tf.gethostbyname ||
7e66e54d 1152 string_is_ip_address(host->name, NULL) != 0)
059ec3d9
PH
1153 (void)host_find_byname(host, NULL, &canonical_name, TRUE);
1154 else
1155 {
1156 int flags = HOST_FIND_BY_A;
1157 if (tf.qualify_single) flags |= HOST_FIND_QUALIFY_SINGLE;
1158 if (tf.search_parents) flags |= HOST_FIND_SEARCH_PARENTS;
1159 (void)host_find_bydns(host, NULL, flags, NULL, NULL, NULL,
1160 &canonical_name, NULL);
1161 }
1162 }
1163 }
1164 }
1165 }
1166
8e669ac1 1167 /* Can only do a callout if we have at least one host! If the callout
2c7db3f5 1168 fails, it will have set ${sender,recipient}_verify_failure. */
059ec3d9
PH
1169
1170 if (host_list != NULL)
1171 {
1172 HDEBUG(D_verify) debug_printf("Attempting full verification using callout\n");
1173 if (host_checking && !host_checking_callout)
1174 {
1175 HDEBUG(D_verify)
1176 debug_printf("... callout omitted by default when host testing\n"
1177 "(Use -bhc if you want the callouts to happen.)\n");
1178 }
1179 else
1180 {
1181 rc = do_callout(addr, host_list, &tf, callout, callout_overall,
4deaf07d 1182 callout_connect, options, se_mailfrom, pm_mailfrom);
059ec3d9
PH
1183 }
1184 }
1185 else
1186 {
1187 HDEBUG(D_verify) debug_printf("Cannot do callout: neither router nor "
1188 "transport provided a host list\n");
1189 }
1190 }
1191 }
8e669ac1 1192
2c7db3f5 1193 /* Otherwise, any failure is a routing failure */
8e669ac1
PH
1194
1195 else *failure_ptr = US"route";
059ec3d9
PH
1196
1197 /* A router may return REROUTED if it has set up a child address as a result
1198 of a change of domain name (typically from widening). In this case we always
1199 want to continue to verify the new child. */
1200
1201 if (rc == REROUTED) continue;
8e669ac1 1202
059ec3d9
PH
1203 /* Handle hard failures */
1204
1205 if (rc == FAIL)
1206 {
1207 allok = FALSE;
1208 if (f != NULL)
1209 {
1210 fprintf(f, "%s%s %s", ko_prefix, address,
1211 address_test_mode? "is undeliverable" : "failed to verify");
1212 if (!expn && admin_user)
1213 {
1214 if (addr->basic_errno > 0)
1215 fprintf(f, ": %s", strerror(addr->basic_errno));
1216 if (addr->message != NULL)
1217 fprintf(f, ":\n %s", addr->message);
1218 }
1219 fprintf(f, "%s\n", cr);
1220 }
1221
1222 if (!full_info) return copy_error(vaddr, addr, FAIL);
1223 else yield = FAIL;
1224 }
1225
1226 /* Soft failure */
1227
1228 else if (rc == DEFER)
1229 {
1230 allok = FALSE;
1231 if (f != NULL)
1232 {
1233 fprintf(f, "%s%s cannot be resolved at this time", ko_prefix, address);
1234 if (!expn && admin_user)
1235 {
1236 if (addr->basic_errno > 0)
1237 fprintf(f, ":\n %s", strerror(addr->basic_errno));
1238 if (addr->message != NULL)
1239 fprintf(f, ":\n %s", addr->message);
1240 else if (addr->basic_errno <= 0)
1241 fprintf(f, ":\n unknown error");
1242 }
1243
1244 fprintf(f, "%s\n", cr);
1245 }
1246 if (!full_info) return copy_error(vaddr, addr, DEFER);
1247 else if (yield == OK) yield = DEFER;
1248 }
1249
1250 /* If we are handling EXPN, we do not want to continue to route beyond
1251 the top level. */
1252
1253 else if (expn)
1254 {
1255 uschar *ok_prefix = US"250-";
1256 if (addr_new == NULL)
1257 {
1258 if (addr_local == NULL && addr_remote == NULL)
1259 fprintf(f, "250 mail to <%s> is discarded\r\n", address);
1260 else
1261 fprintf(f, "250 <%s>\r\n", address);
1262 }
1263 else while (addr_new != NULL)
1264 {
1265 address_item *addr2 = addr_new;
1266 addr_new = addr2->next;
1267 if (addr_new == NULL) ok_prefix = US"250 ";
1268 fprintf(f, "%s<%s>\r\n", ok_prefix, addr2->address);
1269 }
1270 return OK;
1271 }
1272
1273 /* Successful routing other than EXPN. */
1274
1275 else
1276 {
1277 /* Handle successful routing when short info wanted. Otherwise continue for
1278 other (generated) addresses. Short info is the operational case. Full info
1279 can be requested only when debug_selector != 0 and a file is supplied.
1280
1281 There is a conflict between the use of aliasing as an alternate email
1282 address, and as a sort of mailing list. If an alias turns the incoming
1283 address into just one address (e.g. J.Caesar->jc44) you may well want to
1284 carry on verifying the generated address to ensure it is valid when
1285 checking incoming mail. If aliasing generates multiple addresses, you
1286 probably don't want to do this. Exim therefore treats the generation of
1287 just a single new address as a special case, and continues on to verify the
1288 generated address. */
1289
1290 if (!full_info && /* Stop if short info wanted AND */
eafd343b
TK
1291 (((addr_new == NULL || /* No new address OR */
1292 addr_new->next != NULL || /* More than one new address OR */
1293 testflag(addr_new, af_pfr))) /* New address is pfr */
1294 || /* OR */
1295 (addr_new != NULL && /* At least one new address AND */
1296 success_on_redirect))) /* success_on_redirect is set */
059ec3d9
PH
1297 {
1298 if (f != NULL) fprintf(f, "%s %s\n", address,
1299 address_test_mode? "is deliverable" : "verified");
1300
1301 /* If we have carried on to verify a child address, we want the value
1302 of $address_data to be that of the child */
1303
1304 vaddr->p.address_data = addr->p.address_data;
1305 return OK;
1306 }
1307 }
1308 } /* Loop for generated addresses */
1309
1310/* Display the full results of the successful routing, including any generated
1311addresses. Control gets here only when full_info is set, which requires f not
1312to be NULL, and this occurs only when a top-level verify is called with the
1313debugging switch on.
1314
1315If there are no local and no remote addresses, and there were no pipes, files,
1316or autoreplies, and there were no errors or deferments, the message is to be
1317discarded, usually because of the use of :blackhole: in an alias file. */
1318
1319if (allok && addr_local == NULL && addr_remote == NULL)
dbcef0ea 1320 {
059ec3d9 1321 fprintf(f, "mail to %s is discarded\n", address);
dbcef0ea
PH
1322 return yield;
1323 }
059ec3d9 1324
dbcef0ea 1325for (addr_list = addr_local, i = 0; i < 2; addr_list = addr_remote, i++)
059ec3d9
PH
1326 {
1327 while (addr_list != NULL)
1328 {
1329 address_item *addr = addr_list;
1330 address_item *p = addr->parent;
1331 addr_list = addr->next;
1332
1333 fprintf(f, "%s", CS addr->address);
384152a6
TK
1334#ifdef EXPERIMENTAL_SRS
1335 if(addr->p.srs_sender)
1336 fprintf(f, " [srs = %s]", addr->p.srs_sender);
1337#endif
dbcef0ea
PH
1338
1339 /* If the address is a duplicate, show something about it. */
1340
1341 if (!testflag(addr, af_pfr))
1342 {
1343 tree_node *tnode;
1344 if ((tnode = tree_search(tree_duplicates, addr->unique)) != NULL)
1345 fprintf(f, " [duplicate, would not be delivered]");
1346 else tree_add_duplicate(addr->unique, addr);
1347 }
1348
1349 /* Now show its parents */
1350
059ec3d9
PH
1351 while (p != NULL)
1352 {
1353 fprintf(f, "\n <-- %s", p->address);
1354 p = p->parent;
1355 }
1356 fprintf(f, "\n ");
1357
1358 /* Show router, and transport */
1359
1360 fprintf(f, "router = %s, ", addr->router->name);
1361 fprintf(f, "transport = %s\n", (addr->transport == NULL)? US"unset" :
1362 addr->transport->name);
1363
1364 /* Show any hosts that are set up by a router unless the transport
1365 is going to override them; fiddle a bit to get a nice format. */
1366
1367 if (addr->host_list != NULL && addr->transport != NULL &&
1368 !addr->transport->overrides_hosts)
1369 {
1370 host_item *h;
1371 int maxlen = 0;
1372 int maxaddlen = 0;
1373 for (h = addr->host_list; h != NULL; h = h->next)
1374 {
1375 int len = Ustrlen(h->name);
1376 if (len > maxlen) maxlen = len;
1377 len = (h->address != NULL)? Ustrlen(h->address) : 7;
1378 if (len > maxaddlen) maxaddlen = len;
1379 }
1380 for (h = addr->host_list; h != NULL; h = h->next)
1381 {
1382 int len = Ustrlen(h->name);
1383 fprintf(f, " host %s ", h->name);
1384 while (len++ < maxlen) fprintf(f, " ");
1385 if (h->address != NULL)
1386 {
1387 fprintf(f, "[%s] ", h->address);
1388 len = Ustrlen(h->address);
1389 }
1390 else if (!addr->transport->info->local) /* Omit [unknown] for local */
1391 {
1392 fprintf(f, "[unknown] ");
1393 len = 7;
1394 }
1395 else len = -3;
1396 while (len++ < maxaddlen) fprintf(f," ");
1397 if (h->mx >= 0) fprintf(f, "MX=%d", h->mx);
1398 if (h->port != PORT_NONE) fprintf(f, " port=%d", h->port);
1399 if (h->status == hstatus_unusable) fprintf(f, " ** unusable **");
1400 fprintf(f, "\n");
1401 }
1402 }
1403 }
1404 }
1405
8e669ac1 1406/* Will be DEFER or FAIL if any one address has, only for full_info (which is
2c7db3f5
PH
1407the -bv or -bt case). */
1408
8e669ac1 1409return yield;
059ec3d9
PH
1410}
1411
1412
1413
1414
1415/*************************************************
1416* Check headers for syntax errors *
1417*************************************************/
1418
1419/* This function checks those header lines that contain addresses, and verifies
1420that all the addresses therein are syntactially correct.
1421
1422Arguments:
1423 msgptr where to put an error message
1424
1425Returns: OK
1426 FAIL
1427*/
1428
1429int
1430verify_check_headers(uschar **msgptr)
1431{
1432header_line *h;
1433uschar *colon, *s;
1434
1435for (h = header_list; h != NULL; h = h->next)
1436 {
1437 if (h->type != htype_from &&
1438 h->type != htype_reply_to &&
1439 h->type != htype_sender &&
1440 h->type != htype_to &&
1441 h->type != htype_cc &&
1442 h->type != htype_bcc)
1443 continue;
1444
1445 colon = Ustrchr(h->text, ':');
1446 s = colon + 1;
1447 while (isspace(*s)) s++;
1448
1449 parse_allow_group = TRUE; /* Allow group syntax */
1450
1451 /* Loop for multiple addresses in the header */
1452
1453 while (*s != 0)
1454 {
1455 uschar *ss = parse_find_address_end(s, FALSE);
1456 uschar *recipient, *errmess;
1457 int terminator = *ss;
1458 int start, end, domain;
1459
1460 /* Temporarily terminate the string at this point, and extract the
1461 operative address within. */
1462
1463 *ss = 0;
1464 recipient = parse_extract_address(s,&errmess,&start,&end,&domain,FALSE);
1465 *ss = terminator;
1466
1467 /* Permit an unqualified address only if the message is local, or if the
1468 sending host is configured to be permitted to send them. */
1469
1470 if (recipient != NULL && domain == 0)
1471 {
1472 if (h->type == htype_from || h->type == htype_sender)
1473 {
1474 if (!allow_unqualified_sender) recipient = NULL;
1475 }
1476 else
1477 {
1478 if (!allow_unqualified_recipient) recipient = NULL;
1479 }
1480 if (recipient == NULL) errmess = US"unqualified address not permitted";
1481 }
1482
1483 /* It's an error if no address could be extracted, except for the special
1484 case of an empty address. */
1485
1486 if (recipient == NULL && Ustrcmp(errmess, "empty address") != 0)
1487 {
1488 uschar *verb = US"is";
1489 uschar *t = ss;
1ab95fa6 1490 uschar *tt = colon;
059ec3d9
PH
1491 int len;
1492
1493 /* Arrange not to include any white space at the end in the
1ab95fa6 1494 error message or the header name. */
059ec3d9
PH
1495
1496 while (t > s && isspace(t[-1])) t--;
1ab95fa6 1497 while (tt > h->text && isspace(tt[-1])) tt--;
059ec3d9 1498
1ab95fa6 1499 /* Add the address that failed to the error message, since in a
059ec3d9
PH
1500 header with very many addresses it is sometimes hard to spot
1501 which one is at fault. However, limit the amount of address to
1502 quote - cases have been seen where, for example, a missing double
1503 quote in a humungous To: header creates an "address" that is longer
1504 than string_sprintf can handle. */
1505
1506 len = t - s;
1507 if (len > 1024)
1508 {
1509 len = 1024;
1510 verb = US"begins";
1511 }
1512
1513 *msgptr = string_printing(
1ab95fa6
PH
1514 string_sprintf("%s: failing address in \"%.*s:\" header %s: %.*s",
1515 errmess, tt - h->text, h->text, verb, len, s));
059ec3d9
PH
1516
1517 return FAIL;
1518 }
1519
1520 /* Advance to the next address */
1521
1522 s = ss + (terminator? 1:0);
1523 while (isspace(*s)) s++;
1524 } /* Next address */
1525 } /* Next header */
1526
1527return OK;
1528}
1529
1530
1531
1c41c9cc
PH
1532/*************************************************
1533* Check for blind recipients *
1534*************************************************/
1535
1536/* This function checks that every (envelope) recipient is mentioned in either
1537the To: or Cc: header lines, thus detecting blind carbon copies.
1538
1539There are two ways of scanning that could be used: either scan the header lines
1540and tick off the recipients, or scan the recipients and check the header lines.
1541The original proposed patch did the former, but I have chosen to do the latter,
1542because (a) it requires no memory and (b) will use fewer resources when there
1543are many addresses in To: and/or Cc: and only one or two envelope recipients.
1544
1545Arguments: none
1546Returns: OK if there are no blind recipients
1547 FAIL if there is at least one blind recipient
1548*/
1549
1550int
1551verify_check_notblind(void)
1552{
1553int i;
1554for (i = 0; i < recipients_count; i++)
1555 {
1556 header_line *h;
1557 BOOL found = FALSE;
1558 uschar *address = recipients_list[i].address;
1559
1560 for (h = header_list; !found && h != NULL; h = h->next)
1561 {
1562 uschar *colon, *s;
1563
1564 if (h->type != htype_to && h->type != htype_cc) continue;
1565
1566 colon = Ustrchr(h->text, ':');
1567 s = colon + 1;
1568 while (isspace(*s)) s++;
1569
1570 parse_allow_group = TRUE; /* Allow group syntax */
1571
1572 /* Loop for multiple addresses in the header */
1573
1574 while (*s != 0)
1575 {
1576 uschar *ss = parse_find_address_end(s, FALSE);
1577 uschar *recipient,*errmess;
1578 int terminator = *ss;
1579 int start, end, domain;
1580
1581 /* Temporarily terminate the string at this point, and extract the
1582 operative address within. */
1583
1584 *ss = 0;
1585 recipient = parse_extract_address(s,&errmess,&start,&end,&domain,FALSE);
1586 *ss = terminator;
1587
1588 /* If we found a valid recipient that has a domain, compare it with the
1589 envelope recipient. Local parts are compared case-sensitively, domains
1590 case-insensitively. By comparing from the start with length "domain", we
1591 include the "@" at the end, which ensures that we are comparing the whole
1592 local part of each address. */
1593
1594 if (recipient != NULL && domain != 0)
1595 {
1596 found = Ustrncmp(recipient, address, domain) == 0 &&
1597 strcmpic(recipient + domain, address + domain) == 0;
1598 if (found) break;
1599 }
1600
1601 /* Advance to the next address */
1602
1603 s = ss + (terminator? 1:0);
1604 while (isspace(*s)) s++;
1605 } /* Next address */
1606 } /* Next header (if found is false) */
1607
1608 if (!found) return FAIL;
1609 } /* Next recipient */
1610
1611return OK;
1612}
1613
1614
059ec3d9
PH
1615
1616/*************************************************
1617* Find if verified sender *
1618*************************************************/
1619
1620/* Usually, just a single address is verified as the sender of the message.
1621However, Exim can be made to verify other addresses as well (often related in
1622some way), and this is useful in some environments. There may therefore be a
1623chain of such addresses that have previously been tested. This function finds
1624whether a given address is on the chain.
1625
1626Arguments: the address to be verified
1627Returns: pointer to an address item, or NULL
1628*/
1629
1630address_item *
1631verify_checked_sender(uschar *sender)
1632{
1633address_item *addr;
1634for (addr = sender_verified_list; addr != NULL; addr = addr->next)
1635 if (Ustrcmp(sender, addr->address) == 0) break;
1636return addr;
1637}
1638
1639
1640
1641
1642
1643/*************************************************
1644* Get valid header address *
1645*************************************************/
1646
1647/* Scan the originator headers of the message, looking for an address that
1648verifies successfully. RFC 822 says:
1649
1650 o The "Sender" field mailbox should be sent notices of
1651 any problems in transport or delivery of the original
1652 messages. If there is no "Sender" field, then the
1653 "From" field mailbox should be used.
1654
1655 o If the "Reply-To" field exists, then the reply should
1656 go to the addresses indicated in that field and not to
1657 the address(es) indicated in the "From" field.
1658
1659So we check a Sender field if there is one, else a Reply_to field, else a From
1660field. As some strange messages may have more than one of these fields,
1661especially if they are resent- fields, check all of them if there is more than
1662one.
1663
1664Arguments:
1665 user_msgptr points to where to put a user error message
1666 log_msgptr points to where to put a log error message
1667 callout timeout for callout check (passed to verify_address())
1668 callout_overall overall callout timeout (ditto)
8e669ac1 1669 callout_connect connect callout timeout (ditto)
059ec3d9
PH
1670 se_mailfrom mailfrom for verify; NULL => ""
1671 pm_mailfrom sender for pm callout check (passed to verify_address())
1672 options callout options (passed to verify_address())
8e669ac1 1673 verrno where to put the address basic_errno
059ec3d9
PH
1674
1675If log_msgptr is set to something without setting user_msgptr, the caller
1676normally uses log_msgptr for both things.
1677
1678Returns: result of the verification attempt: OK, FAIL, or DEFER;
1679 FAIL is given if no appropriate headers are found
1680*/
1681
1682int
1683verify_check_header_address(uschar **user_msgptr, uschar **log_msgptr,
8e669ac1 1684 int callout, int callout_overall, int callout_connect, uschar *se_mailfrom,
fe5b5d0b 1685 uschar *pm_mailfrom, int options, int *verrno)
059ec3d9
PH
1686{
1687static int header_types[] = { htype_sender, htype_reply_to, htype_from };
1688int yield = FAIL;
1689int i;
1690
1691for (i = 0; i < 3; i++)
1692 {
1693 header_line *h;
1694 for (h = header_list; h != NULL; h = h->next)
1695 {
1696 int terminator, new_ok;
1697 uschar *s, *ss, *endname;
1698
1699 if (h->type != header_types[i]) continue;
1700 s = endname = Ustrchr(h->text, ':') + 1;
1701
1702 while (*s != 0)
1703 {
1704 address_item *vaddr;
1705
1706 while (isspace(*s) || *s == ',') s++;
1707 if (*s == 0) break; /* End of header */
1708
1709 ss = parse_find_address_end(s, FALSE);
1710
1711 /* The terminator is a comma or end of header, but there may be white
1712 space preceding it (including newline for the last address). Move back
1713 past any white space so we can check against any cached envelope sender
1714 address verifications. */
1715
1716 while (isspace(ss[-1])) ss--;
1717 terminator = *ss;
1718 *ss = 0;
1719
1720 HDEBUG(D_verify) debug_printf("verifying %.*s header address %s\n",
1721 (int)(endname - h->text), h->text, s);
1722
1723 /* See if we have already verified this address as an envelope sender,
1724 and if so, use the previous answer. */
1725
1726 vaddr = verify_checked_sender(s);
1727
1728 if (vaddr != NULL && /* Previously checked */
1729 (callout <= 0 || /* No callout needed; OR */
1730 vaddr->special_action > 256)) /* Callout was done */
1731 {
1732 new_ok = vaddr->special_action & 255;
1733 HDEBUG(D_verify) debug_printf("previously checked as envelope sender\n");
1734 *ss = terminator; /* Restore shortened string */
1735 }
1736
1737 /* Otherwise we run the verification now. We must restore the shortened
1738 string before running the verification, so the headers are correct, in
1739 case there is any rewriting. */
1740
1741 else
1742 {
1743 int start, end, domain;
1744 uschar *address = parse_extract_address(s, log_msgptr, &start,
1745 &end, &domain, FALSE);
1746
1747 *ss = terminator;
1748
1749 /* If verification failed because of a syntax error, fail this
1750 function, and ensure that the failing address gets added to the error
1751 message. */
1752
1753 if (address == NULL)
1754 {
1755 new_ok = FAIL;
1756 if (*log_msgptr != NULL)
1757 {
1758 while (ss > s && isspace(ss[-1])) ss--;
1759 *log_msgptr = string_sprintf("syntax error in '%.*s' header when "
1760 "scanning for sender: %s in \"%.*s\"",
1761 endname - h->text, h->text, *log_msgptr, ss - s, s);
1762 return FAIL;
1763 }
1764 }
1765
2f6603e1 1766 /* Else go ahead with the sender verification. But it isn't *the*
059ec3d9
PH
1767 sender of the message, so set vopt_fake_sender to stop sender_address
1768 being replaced after rewriting or qualification. */
1769
1770 else
1771 {
1772 vaddr = deliver_make_addr(address, FALSE);
1773 new_ok = verify_address(vaddr, NULL, options | vopt_fake_sender,
8e669ac1 1774 callout, callout_overall, callout_connect, se_mailfrom,
4deaf07d 1775 pm_mailfrom, NULL);
059ec3d9
PH
1776 }
1777 }
1778
1779 /* We now have the result, either newly found, or cached. If we are
1780 giving out error details, set a specific user error. This means that the
1781 last of these will be returned to the user if all three fail. We do not
1782 set a log message - the generic one below will be used. */
1783
fe5b5d0b 1784 if (new_ok != OK)
059ec3d9 1785 {
8e669ac1 1786 *verrno = vaddr->basic_errno;
fe5b5d0b
PH
1787 if (smtp_return_error_details)
1788 {
1789 *user_msgptr = string_sprintf("Rejected after DATA: "
1790 "could not verify \"%.*s\" header address\n%s: %s",
1791 endname - h->text, h->text, vaddr->address, vaddr->message);
1792 }
8e669ac1 1793 }
059ec3d9
PH
1794
1795 /* Success or defer */
1796
1797 if (new_ok == OK) return OK;
1798 if (new_ok == DEFER) yield = DEFER;
1799
1800 /* Move on to any more addresses in the header */
1801
1802 s = ss;
1803 }
1804 }
1805 }
1806
1807if (yield == FAIL && *log_msgptr == NULL)
1808 *log_msgptr = US"there is no valid sender in any header line";
1809
1810if (yield == DEFER && *log_msgptr == NULL)
1811 *log_msgptr = US"all attempts to verify a sender in a header line deferred";
1812
1813return yield;
1814}
1815
1816
1817
1818
1819/*************************************************
1820* Get RFC 1413 identification *
1821*************************************************/
1822
1823/* Attempt to get an id from the sending machine via the RFC 1413 protocol. If
1824the timeout is set to zero, then the query is not done. There may also be lists
1825of hosts and nets which are exempt. To guard against malefactors sending
1826non-printing characters which could, for example, disrupt a message's headers,
1827make sure the string consists of printing characters only.
1828
1829Argument:
1830 port the port to connect to; usually this is IDENT_PORT (113), but when
1831 running in the test harness with -bh a different value is used.
1832
1833Returns: nothing
1834
1835Side effect: any received ident value is put in sender_ident (NULL otherwise)
1836*/
1837
1838void
1839verify_get_ident(int port)
1840{
1841int sock, host_af, qlen;
1842int received_sender_port, received_interface_port, n;
1843uschar *p;
1844uschar buffer[2048];
1845
1846/* Default is no ident. Check whether we want to do an ident check for this
1847host. */
1848
1849sender_ident = NULL;
1850if (rfc1413_query_timeout <= 0 || verify_check_host(&rfc1413_hosts) != OK)
1851 return;
1852
1853DEBUG(D_ident) debug_printf("doing ident callback\n");
1854
1855/* Set up a connection to the ident port of the remote host. Bind the local end
1856to the incoming interface address. If the sender host address is an IPv6
1857address, the incoming interface address will also be IPv6. */
1858
1859host_af = (Ustrchr(sender_host_address, ':') == NULL)? AF_INET : AF_INET6;
1860sock = ip_socket(SOCK_STREAM, host_af);
1861if (sock < 0) return;
1862
1863if (ip_bind(sock, host_af, interface_address, 0) < 0)
1864 {
1865 DEBUG(D_ident) debug_printf("bind socket for ident failed: %s\n",
1866 strerror(errno));
1867 goto END_OFF;
1868 }
1869
1870if (ip_connect(sock, host_af, sender_host_address, port, rfc1413_query_timeout)
1871 < 0)
1872 {
1873 if (errno == ETIMEDOUT && (log_extra_selector & LX_ident_timeout) != 0)
1874 {
1875 log_write(0, LOG_MAIN, "ident connection to %s timed out",
1876 sender_host_address);
1877 }
1878 else
1879 {
1880 DEBUG(D_ident) debug_printf("ident connection to %s failed: %s\n",
1881 sender_host_address, strerror(errno));
1882 }
1883 goto END_OFF;
1884 }
1885
1886/* Construct and send the query. */
1887
1888sprintf(CS buffer, "%d , %d\r\n", sender_host_port, interface_port);
1889qlen = Ustrlen(buffer);
1890if (send(sock, buffer, qlen, 0) < 0)
1891 {
1892 DEBUG(D_ident) debug_printf("ident send failed: %s\n", strerror(errno));
1893 goto END_OFF;
1894 }
1895
1896/* Read a response line. We put it into the rest of the buffer, using several
1897recv() calls if necessary. */
1898
1899p = buffer + qlen;
1900
1901for (;;)
1902 {
1903 uschar *pp;
1904 int count;
1905 int size = sizeof(buffer) - (p - buffer);
1906
1907 if (size <= 0) goto END_OFF; /* Buffer filled without seeing \n. */
1908 count = ip_recv(sock, p, size, rfc1413_query_timeout);
1909 if (count <= 0) goto END_OFF; /* Read error or EOF */
1910
1911 /* Scan what we just read, to see if we have reached the terminating \r\n. Be
1912 generous, and accept a plain \n terminator as well. The only illegal
1913 character is 0. */
1914
1915 for (pp = p; pp < p + count; pp++)
1916 {
1917 if (*pp == 0) goto END_OFF; /* Zero octet not allowed */
1918 if (*pp == '\n')
1919 {
1920 if (pp[-1] == '\r') pp--;
1921 *pp = 0;
1922 goto GOT_DATA; /* Break out of both loops */
1923 }
1924 }
1925
1926 /* Reached the end of the data without finding \n. Let the loop continue to
1927 read some more, if there is room. */
1928
1929 p = pp;
1930 }
1931
1932GOT_DATA:
1933
1934/* We have received a line of data. Check it carefully. It must start with the
1935same two port numbers that we sent, followed by data as defined by the RFC. For
1936example,
1937
1938 12345 , 25 : USERID : UNIX :root
1939
1940However, the amount of white space may be different to what we sent. In the
1941"osname" field there may be several sub-fields, comma separated. The data we
1942actually want to save follows the third colon. Some systems put leading spaces
1943in it - we discard those. */
1944
1945if (sscanf(CS buffer + qlen, "%d , %d%n", &received_sender_port,
1946 &received_interface_port, &n) != 2 ||
1947 received_sender_port != sender_host_port ||
1948 received_interface_port != interface_port)
1949 goto END_OFF;
1950
1951p = buffer + qlen + n;
1952while(isspace(*p)) p++;
1953if (*p++ != ':') goto END_OFF;
1954while(isspace(*p)) p++;
1955if (Ustrncmp(p, "USERID", 6) != 0) goto END_OFF;
1956p += 6;
1957while(isspace(*p)) p++;
1958if (*p++ != ':') goto END_OFF;
1959while (*p != 0 && *p != ':') p++;
1960if (*p++ == 0) goto END_OFF;
1961while(isspace(*p)) p++;
1962if (*p == 0) goto END_OFF;
1963
1964/* The rest of the line is the data we want. We turn it into printing
1965characters when we save it, so that it cannot mess up the format of any logging
1966or Received: lines into which it gets inserted. We keep a maximum of 127
1967characters. */
1968
1969sender_ident = string_printing(string_copyn(p, 127));
1970DEBUG(D_ident) debug_printf("sender_ident = %s\n", sender_ident);
1971
1972END_OFF:
f1e894f3 1973(void)close(sock);
059ec3d9
PH
1974return;
1975}
1976
1977
1978
1979
1980/*************************************************
1981* Match host to a single host-list item *
1982*************************************************/
1983
1984/* This function compares a host (name or address) against a single item
1985from a host list. The host name gets looked up if it is needed and is not
1986already known. The function is called from verify_check_this_host() via
1987match_check_list(), which is why most of its arguments are in a single block.
1988
1989Arguments:
1990 arg the argument block (see below)
1991 ss the host-list item
1992 valueptr where to pass back looked up data, or NULL
1993 error for error message when returning ERROR
1994
1995The block contains:
32d668a5
PH
1996 host_name (a) the host name, or
1997 (b) NULL, implying use sender_host_name and
1998 sender_host_aliases, looking them up if required, or
1999 (c) the empty string, meaning that only IP address matches
2000 are permitted
059ec3d9
PH
2001 host_address the host address
2002 host_ipv4 the IPv4 address taken from an IPv6 one
2003
2004Returns: OK matched
2005 FAIL did not match
2006 DEFER lookup deferred
32d668a5
PH
2007 ERROR (a) failed to find the host name or IP address, or
2008 (b) unknown lookup type specified, or
2009 (c) host name encountered when only IP addresses are
2010 being matched
059ec3d9
PH
2011*/
2012
32d668a5 2013int
059ec3d9
PH
2014check_host(void *arg, uschar *ss, uschar **valueptr, uschar **error)
2015{
2016check_host_block *cb = (check_host_block *)arg;
32d668a5 2017int mlen = -1;
059ec3d9 2018int maskoffset;
32d668a5 2019BOOL iplookup = FALSE;
059ec3d9 2020BOOL isquery = FALSE;
32d668a5 2021BOOL isiponly = cb->host_name != NULL && cb->host_name[0] == 0;
1688f43b 2022uschar *t;
32d668a5 2023uschar *semicolon;
059ec3d9
PH
2024uschar **aliases;
2025
2026/* Optimize for the special case when the pattern is "*". */
2027
2028if (*ss == '*' && ss[1] == 0) return OK;
2029
2030/* If the pattern is empty, it matches only in the case when there is no host -
2031this can occur in ACL checking for SMTP input using the -bs option. In this
2032situation, the host address is the empty string. */
2033
2034if (cb->host_address[0] == 0) return (*ss == 0)? OK : FAIL;
2035if (*ss == 0) return FAIL;
2036
32d668a5
PH
2037/* If the pattern is precisely "@" then match against the primary host name,
2038provided that host name matching is permitted; if it's "@[]" match against the
2039local host's IP addresses. */
059ec3d9
PH
2040
2041if (*ss == '@')
2042 {
32d668a5
PH
2043 if (ss[1] == 0)
2044 {
2045 if (isiponly) return ERROR;
2046 ss = primary_hostname;
2047 }
059ec3d9
PH
2048 else if (Ustrcmp(ss, "@[]") == 0)
2049 {
2050 ip_address_item *ip;
2051 for (ip = host_find_interfaces(); ip != NULL; ip = ip->next)
2052 if (Ustrcmp(ip->address, cb->host_address) == 0) return OK;
2053 return FAIL;
2054 }
2055 }
2056
2057/* If the pattern is an IP address, optionally followed by a bitmask count, do
2058a (possibly masked) comparision with the current IP address. */
2059
7e66e54d 2060if (string_is_ip_address(ss, &maskoffset) != 0)
059ec3d9
PH
2061 return (host_is_in_net(cb->host_address, ss, maskoffset)? OK : FAIL);
2062
1688f43b
PH
2063/* The pattern is not an IP address. A common error that people make is to omit
2064one component of an IPv4 address, either by accident, or believing that, for
2065example, 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,
2066which it isn't. (Those applications that do accept 1.2.3 as an IP address
2067interpret it as 1.2.0.3 because the final component becomes 16-bit - this is an
2068ancient specification.) To aid in debugging these cases, we give a specific
2069error if the pattern contains only digits and dots or contains a slash preceded
2070only by digits and dots (a slash at the start indicates a file name and of
2071course slashes may be present in lookups, but not preceded only by digits and
2072dots). */
2073
2074for (t = ss; isdigit(*t) || *t == '.'; t++);
2075if (*t == 0 || (*t == '/' && t != ss))
2076 {
2077 *error = US"malformed IPv4 address or address mask";
2078 return ERROR;
2079 }
2080
32d668a5 2081/* See if there is a semicolon in the pattern */
059ec3d9 2082
32d668a5
PH
2083semicolon = Ustrchr(ss, ';');
2084
2085/* If we are doing an IP address only match, then all lookups must be IP
df199fec 2086address lookups, even if there is no "net-". */
32d668a5
PH
2087
2088if (isiponly)
059ec3d9 2089 {
32d668a5
PH
2090 iplookup = semicolon != NULL;
2091 }
059ec3d9 2092
32d668a5 2093/* Otherwise, if the item is of the form net[n]-lookup;<file|query> then it is
df199fec
PH
2094a lookup on a masked IP network, in textual form. We obey this code even if we
2095have already set iplookup, so as to skip over the "net-" prefix and to set the
2096mask length. The net- stuff really only applies to single-key lookups where the
2097key is implicit. For query-style lookups the key is specified in the query.
2098From release 4.30, the use of net- for query style is no longer needed, but we
2099retain it for backward compatibility. */
2100
2101if (Ustrncmp(ss, "net", 3) == 0 && semicolon != NULL)
32d668a5
PH
2102 {
2103 mlen = 0;
2104 for (t = ss + 3; isdigit(*t); t++) mlen = mlen * 10 + *t - '0';
2105 if (mlen == 0 && t == ss+3) mlen = -1; /* No mask supplied */
2106 iplookup = (*t++ == '-');
2107 }
1688f43b 2108else t = ss;
059ec3d9 2109
32d668a5 2110/* Do the IP address lookup if that is indeed what we have */
059ec3d9 2111
32d668a5
PH
2112if (iplookup)
2113 {
2114 int insize;
2115 int search_type;
2116 int incoming[4];
2117 void *handle;
2118 uschar *filename, *key, *result;
2119 uschar buffer[64];
059ec3d9 2120
32d668a5 2121 /* Find the search type */
059ec3d9 2122
32d668a5 2123 search_type = search_findtype(t, semicolon - t);
059ec3d9 2124
32d668a5
PH
2125 if (search_type < 0) log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s",
2126 search_error_message);
059ec3d9 2127
13b685f9
PH
2128 /* Adjust parameters for the type of lookup. For a query-style lookup, there
2129 is no file name, and the "key" is just the query. For query-style with a file
2130 name, we have to fish the file off the start of the query. For a single-key
2131 lookup, the key is the current IP address, masked appropriately, and
2132 reconverted to text form, with the mask appended. For IPv6 addresses, specify
2133 dot separators instead of colons. */
059ec3d9 2134
13b685f9
PH
2135 if (mac_islookup(search_type, lookup_absfilequery))
2136 {
2137 filename = semicolon + 1;
2138 key = filename;
2139 while (*key != 0 && !isspace(*key)) key++;
2140 filename = string_copyn(filename, key - filename);
2141 while (isspace(*key)) key++;
2142 }
2143 else if (mac_islookup(search_type, lookup_querystyle))
32d668a5
PH
2144 {
2145 filename = NULL;
2146 key = semicolon + 1;
2147 }
2148 else
2149 {
2150 insize = host_aton(cb->host_address, incoming);
2151 host_mask(insize, incoming, mlen);
2152 (void)host_nmtoa(insize, incoming, mlen, buffer, '.');
2153 key = buffer;
2154 filename = semicolon + 1;
059ec3d9 2155 }
32d668a5
PH
2156
2157 /* Now do the actual lookup; note that there is no search_close() because
2158 of the caching arrangements. */
2159
2160 handle = search_open(filename, search_type, 0, NULL, NULL);
2161 if (handle == NULL) log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s",
2162 search_error_message);
2163 result = search_find(handle, filename, key, -1, NULL, 0, 0, NULL);
2164 if (valueptr != NULL) *valueptr = result;
2165 return (result != NULL)? OK : search_find_defer? DEFER: FAIL;
059ec3d9
PH
2166 }
2167
2168/* The pattern is not an IP address or network reference of any kind. That is,
32d668a5
PH
2169it is a host name pattern. If this is an IP only match, there's an error in the
2170host list. */
2171
2172if (isiponly)
2173 {
2174 *error = US"cannot match host name in match_ip list";
2175 return ERROR;
2176 }
2177
2178/* Check the characters of the pattern to see if they comprise only letters,
2179digits, full stops, and hyphens (the constituents of domain names). Allow
2180underscores, as they are all too commonly found. Sigh. Also, if
2181allow_utf8_domains is set, allow top-bit characters. */
059ec3d9
PH
2182
2183for (t = ss; *t != 0; t++)
2184 if (!isalnum(*t) && *t != '.' && *t != '-' && *t != '_' &&
2185 (!allow_utf8_domains || *t < 128)) break;
2186
2187/* If the pattern is a complete domain name, with no fancy characters, look up
2188its IP address and match against that. Note that a multi-homed host will add
2189items to the chain. */
2190
2191if (*t == 0)
2192 {
2193 int rc;
2194 host_item h;
2195 h.next = NULL;
2196 h.name = ss;
2197 h.address = NULL;
2198 h.mx = MX_NONE;
9b8fadde 2199
059ec3d9
PH
2200 rc = host_find_byname(&h, NULL, NULL, FALSE);
2201 if (rc == HOST_FOUND || rc == HOST_FOUND_LOCAL)
2202 {
2203 host_item *hh;
2204 for (hh = &h; hh != NULL; hh = hh->next)
2205 {
96776534 2206 if (host_is_in_net(hh->address, cb->host_address, 0)) return OK;
059ec3d9
PH
2207 }
2208 return FAIL;
2209 }
2210 if (rc == HOST_FIND_AGAIN) return DEFER;
2211 *error = string_sprintf("failed to find IP address for %s", ss);
2212 return ERROR;
2213 }
2214
2215/* Almost all subsequent comparisons require the host name, and can be done
2216using the general string matching function. When this function is called for
2217outgoing hosts, the name is always given explicitly. If it is NULL, it means we
2218must use sender_host_name and its aliases, looking them up if necessary. */
2219
2220if (cb->host_name != NULL) /* Explicit host name given */
2221 return match_check_string(cb->host_name, ss, -1, TRUE, TRUE, TRUE,
2222 valueptr);
2223
2224/* Host name not given; in principle we need the sender host name and its
2225aliases. However, for query-style lookups, we do not need the name if the
2226query does not contain $sender_host_name. From release 4.23, a reference to
2227$sender_host_name causes it to be looked up, so we don't need to do the lookup
2228on spec. */
2229
2230if ((semicolon = Ustrchr(ss, ';')) != NULL)
2231 {
2232 uschar *affix;
2233 int partial, affixlen, starflags, id;
2234
2235 *semicolon = 0;
2236 id = search_findtype_partial(ss, &partial, &affix, &affixlen, &starflags);
2237 *semicolon=';';
2238
2239 if (id < 0) /* Unknown lookup type */
2240 {
2241 log_write(0, LOG_MAIN|LOG_PANIC, "%s in host list item \"%s\"",
2242 search_error_message, ss);
2243 return DEFER;
2244 }
13b685f9 2245 isquery = mac_islookup(id, lookup_querystyle|lookup_absfilequery);
059ec3d9
PH
2246 }
2247
2248if (isquery)
2249 {
2250 switch(match_check_string(US"", ss, -1, TRUE, TRUE, TRUE, valueptr))
2251 {
2252 case OK: return OK;
2253 case DEFER: return DEFER;
2254 default: return FAIL;
2255 }
2256 }
2257
2258/* Not a query-style lookup; must ensure the host name is present, and then we
2259do a check on the name and all its aliases. */
2260
2261if (sender_host_name == NULL)
2262 {
2263 HDEBUG(D_host_lookup)
2264 debug_printf("sender host name required, to match against %s\n", ss);
2265 if (host_lookup_failed || host_name_lookup() != OK)
2266 {
2267 *error = string_sprintf("failed to find host name for %s",
2268 sender_host_address);;
2269 return ERROR;
2270 }
2271 host_build_sender_fullhost();
2272 }
2273
2274/* Match on the sender host name, using the general matching function */
2275
2276switch(match_check_string(sender_host_name, ss, -1, TRUE, TRUE, TRUE,
2277 valueptr))
2278 {
2279 case OK: return OK;
2280 case DEFER: return DEFER;
2281 }
2282
2283/* If there are aliases, try matching on them. */
2284
2285aliases = sender_host_aliases;
2286while (*aliases != NULL)
2287 {
2288 switch(match_check_string(*aliases++, ss, -1, TRUE, TRUE, TRUE, valueptr))
2289 {
2290 case OK: return OK;
2291 case DEFER: return DEFER;
2292 }
2293 }
2294return FAIL;
2295}
2296
2297
2298
2299
2300/*************************************************
2301* Check a specific host matches a host list *
2302*************************************************/
2303
2304/* This function is passed a host list containing items in a number of
2305different formats and the identity of a host. Its job is to determine whether
2306the given host is in the set of hosts defined by the list. The host name is
2307passed as a pointer so that it can be looked up if needed and not already
2308known. This is commonly the case when called from verify_check_host() to check
2309an incoming connection. When called from elsewhere the host name should usually
2310be set.
2311
2312This function is now just a front end to match_check_list(), which runs common
2313code for scanning a list. We pass it the check_host() function to perform a
2314single test.
2315
2316Arguments:
2317 listptr pointer to the host list
2318 cache_bits pointer to cache for named lists, or NULL
2319 host_name the host name or NULL, implying use sender_host_name and
2320 sender_host_aliases, looking them up if required
2321 host_address the IP address
2322 valueptr if not NULL, data from a lookup is passed back here
2323
2324Returns: OK if the host is in the defined set
2325 FAIL if the host is not in the defined set,
2326 DEFER if a data lookup deferred (not a host lookup)
2327
2328If the host name was needed in order to make a comparison, and could not be
2329determined from the IP address, the result is FAIL unless the item
2330"+allow_unknown" was met earlier in the list, in which case OK is returned. */
2331
2332int
2333verify_check_this_host(uschar **listptr, unsigned int *cache_bits,
2334 uschar *host_name, uschar *host_address, uschar **valueptr)
2335{
d4eb88df 2336int rc;
059ec3d9 2337unsigned int *local_cache_bits = cache_bits;
d4eb88df 2338uschar *save_host_address = deliver_host_address;
059ec3d9
PH
2339check_host_block cb;
2340cb.host_name = host_name;
2341cb.host_address = host_address;
2342
2343if (valueptr != NULL) *valueptr = NULL;
2344
2345/* If the host address starts off ::ffff: it is an IPv6 address in
2346IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2347addresses. */
2348
2349cb.host_ipv4 = (Ustrncmp(host_address, "::ffff:", 7) == 0)?
2350 host_address + 7 : host_address;
2351
8e669ac1
PH
2352/* During the running of the check, put the IP address into $host_address. In
2353the case of calls from the smtp transport, it will already be there. However,
2354in other calls (e.g. when testing ignore_target_hosts), it won't. Just to be on
d4eb88df
PH
2355the safe side, any existing setting is preserved, though as I write this
2356(November 2004) I can't see any cases where it is actually needed. */
2357
2358deliver_host_address = host_address;
2359rc = match_check_list(
2360 listptr, /* the list */
2361 0, /* separator character */
2362 &hostlist_anchor, /* anchor pointer */
2363 &local_cache_bits, /* cache pointer */
2364 check_host, /* function for testing */
2365 &cb, /* argument for function */
2366 MCL_HOST, /* type of check */
8e669ac1 2367 (host_address == sender_host_address)?
d4eb88df
PH
2368 US"host" : host_address, /* text for debugging */
2369 valueptr); /* where to pass back data */
2370deliver_host_address = save_host_address;
8e669ac1 2371return rc;
059ec3d9
PH
2372}
2373
2374
2375
2376
2377/*************************************************
2378* Check the remote host matches a list *
2379*************************************************/
2380
2381/* This is a front end to verify_check_this_host(), created because checking
2382the remote host is a common occurrence. With luck, a good compiler will spot
2383the tail recursion and optimize it. If there's no host address, this is
2384command-line SMTP input - check against an empty string for the address.
2385
2386Arguments:
2387 listptr pointer to the host list
2388
2389Returns: the yield of verify_check_this_host(),
2390 i.e. OK, FAIL, or DEFER
2391*/
2392
2393int
2394verify_check_host(uschar **listptr)
2395{
2396return verify_check_this_host(listptr, sender_host_cache, NULL,
2397 (sender_host_address == NULL)? US"" : sender_host_address, NULL);
2398}
2399
2400
2401
2402
2403
2404/*************************************************
2405* Invert an IP address for a DNS black list *
2406*************************************************/
2407
2408/*
2409Arguments:
2410 buffer where to put the answer
2411 address the address to invert
2412*/
2413
2414static void
2415invert_address(uschar *buffer, uschar *address)
2416{
2417int bin[4];
2418uschar *bptr = buffer;
2419
2420/* If this is an IPv4 address mapped into IPv6 format, adjust the pointer
2421to the IPv4 part only. */
2422
2423if (Ustrncmp(address, "::ffff:", 7) == 0) address += 7;
2424
2425/* Handle IPv4 address: when HAVE_IPV6 is false, the result of host_aton() is
2426always 1. */
2427
2428if (host_aton(address, bin) == 1)
2429 {
2430 int i;
2431 int x = bin[0];
2432 for (i = 0; i < 4; i++)
2433 {
2434 sprintf(CS bptr, "%d.", x & 255);
2435 while (*bptr) bptr++;
2436 x >>= 8;
2437 }
2438 }
2439
2440/* Handle IPv6 address. Actually, as far as I know, there are no IPv6 addresses
2441in any DNS black lists, and the format in which they will be looked up is
2442unknown. This is just a guess. */
2443
2444#if HAVE_IPV6
2445else
2446 {
2447 int i, j;
2448 for (j = 3; j >= 0; j--)
2449 {
2450 int x = bin[j];
2451 for (i = 0; i < 8; i++)
2452 {
2453 sprintf(CS bptr, "%x.", x & 15);
2454 while (*bptr) bptr++;
2455 x >>= 4;
2456 }
2457 }
2458 }
2459#endif
2460}
2461
2462
2463
0bcb2a0e
PH
2464/*************************************************
2465* Perform a single dnsbl lookup *
2466*************************************************/
2467
2468/* This function is called from verify_check_dnsbl() below.
2469
2470Arguments:
2471 domain the outer dnsbl domain (for debug message)
8e669ac1 2472 keydomain the current keydomain (for debug message)
0bcb2a0e 2473 query the domain to be looked up
8e669ac1
PH
2474 iplist the list of matching IP addresses
2475 bitmask true if bitmask matching is wanted
2476 invert_result true if result to be inverted
2477 defer_return what to return for a defer
0bcb2a0e
PH
2478
2479Returns: OK if lookup succeeded
2480 FAIL if not
2481*/
2482
2483static int
8e669ac1 2484one_check_dnsbl(uschar *domain, uschar *keydomain, uschar *query,
0bcb2a0e 2485 uschar *iplist, BOOL bitmask, BOOL invert_result, int defer_return)
8e669ac1 2486{
0bcb2a0e
PH
2487dns_answer dnsa;
2488dns_scan dnss;
2489tree_node *t;
2490dnsbl_cache_block *cb;
2491int old_pool = store_pool;
2492
2493/* Look for this query in the cache. */
2494
2495t = tree_search(dnsbl_cache, query);
2496
2497/* If not cached from a previous lookup, we must do a DNS lookup, and
2498cache the result in permanent memory. */
2499
2500if (t == NULL)
2501 {
2502 store_pool = POOL_PERM;
2503
2504 /* Set up a tree entry to cache the lookup */
2505
2506 t = store_get(sizeof(tree_node) + Ustrlen(query));
2507 Ustrcpy(t->name, query);
2508 t->data.ptr = cb = store_get(sizeof(dnsbl_cache_block));
2509 (void)tree_insertnode(&dnsbl_cache, t);
2510
2511 /* Do the DNS loopup . */
2512
2513 HDEBUG(D_dnsbl) debug_printf("new DNS lookup for %s\n", query);
2514 cb->rc = dns_basic_lookup(&dnsa, query, T_A);
2515 cb->text_set = FALSE;
2516 cb->text = NULL;
2517 cb->rhs = NULL;
2518
2519 /* If the lookup succeeded, cache the RHS address. The code allows for
2520 more than one address - this was for complete generality and the possible
2521 use of A6 records. However, A6 records have been reduced to experimental
2522 status (August 2001) and may die out. So they may never get used at all,
2523 let alone in dnsbl records. However, leave the code here, just in case.
2524
2525 Quite apart from one A6 RR generating multiple addresses, there are DNS
2526 lists that return more than one A record, so we must handle multiple
2527 addresses generated in that way as well. */
2528
2529 if (cb->rc == DNS_SUCCEED)
2530 {
2531 dns_record *rr;
2532 dns_address **addrp = &(cb->rhs);
2533 for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
2534 rr != NULL;
2535 rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
2536 {
2537 if (rr->type == T_A)
2538 {
2539 dns_address *da = dns_address_from_rr(&dnsa, rr);
2540 if (da != NULL)
2541 {
2542 *addrp = da;
2543 while (da->next != NULL) da = da->next;
2544 addrp = &(da->next);
2545 }
2546 }
2547 }
2548
2549 /* If we didn't find any A records, change the return code. This can
2550 happen when there is a CNAME record but there are no A records for what
2551 it points to. */
2552
2553 if (cb->rhs == NULL) cb->rc = DNS_NODATA;
2554 }
2555
2556 store_pool = old_pool;
2557 }
2558
2559/* Previous lookup was cached */
2560
2561else
2562 {
2563 HDEBUG(D_dnsbl) debug_printf("using result of previous DNS lookup\n");
2564 cb = t->data.ptr;
2565 }
2566
2567/* We now have the result of the DNS lookup, either newly done, or cached
2568from a previous call. If the lookup succeeded, check against the address
2569list if there is one. This may be a positive equality list (introduced by
2570"="), a negative equality list (introduced by "!="), a positive bitmask
2571list (introduced by "&"), or a negative bitmask list (introduced by "!&").*/
2572
2573if (cb->rc == DNS_SUCCEED)
2574 {
2575 dns_address *da = NULL;
2576 uschar *addlist = cb->rhs->address;
2577
2578 /* For A and AAAA records, there may be multiple addresses from multiple
2579 records. For A6 records (currently not expected to be used) there may be
2580 multiple addresses from a single record. */
2581
2582 for (da = cb->rhs->next; da != NULL; da = da->next)
2583 addlist = string_sprintf("%s, %s", addlist, da->address);
2584
2585 HDEBUG(D_dnsbl) debug_printf("DNS lookup for %s succeeded (yielding %s)\n",
2586 query, addlist);
2587
2588 /* Address list check; this can be either for equality, or via a bitmask.
2589 In the latter case, all the bits must match. */
2590
2591 if (iplist != NULL)
2592 {
2593 int ipsep = ',';
2594 uschar ip[46];
2595 uschar *ptr = iplist;
2596
2597 while (string_nextinlist(&ptr, &ipsep, ip, sizeof(ip)) != NULL)
2598 {
2599 /* Handle exact matching */
2600 if (!bitmask)
2601 {
2602 for (da = cb->rhs; da != NULL; da = da->next)
2603 {
2604 if (Ustrcmp(CS da->address, ip) == 0) break;
2605 }
2606 }
2607 /* Handle bitmask matching */
2608 else
2609 {
2610 int address[4];
2611 int mask = 0;
2612
2613 /* At present, all known DNS blocking lists use A records, with
2614 IPv4 addresses on the RHS encoding the information they return. I
2615 wonder if this will linger on as the last vestige of IPv4 when IPv6
2616 is ubiquitous? Anyway, for now we use paranoia code to completely
2617 ignore IPv6 addresses. The default mask is 0, which always matches.
2618 We change this only for IPv4 addresses in the list. */
2619
2620 if (host_aton(ip, address) == 1) mask = address[0];
2621
2622 /* Scan the returned addresses, skipping any that are IPv6 */
2623
2624 for (da = cb->rhs; da != NULL; da = da->next)
2625 {
2626 if (host_aton(da->address, address) != 1) continue;
2627 if ((address[0] & mask) == mask) break;
2628 }
2629 }
2630
2631 /* Break out if a match has been found */
2632
2633 if (da != NULL) break;
2634 }
2635
2636 /* If either
2637
2638 (a) No IP address in a positive list matched, or
2639 (b) An IP address in a negative list did match
2640
2641 then behave as if the DNSBL lookup had not succeeded, i.e. the host is
2642 not on the list. */
2643
2644 if (invert_result != (da == NULL))
2645 {
2646 HDEBUG(D_dnsbl)
2647 {
2648 debug_printf("=> but we are not accepting this block class because\n");
2649 debug_printf("=> there was %s match for %c%s\n",
2650 invert_result? "an exclude":"no", bitmask? '&' : '=', iplist);
2651 }
8e669ac1 2652 return FAIL;
0bcb2a0e
PH
2653 }
2654 }
2655
2656 /* Either there was no IP list, or the record matched. Look up a TXT record
2657 if it hasn't previously been done. */
2658
2659 if (!cb->text_set)
2660 {
2661 cb->text_set = TRUE;
2662 if (dns_basic_lookup(&dnsa, query, T_TXT) == DNS_SUCCEED)
2663 {
2664 dns_record *rr;
2665 for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
2666 rr != NULL;
2667 rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
2668 if (rr->type == T_TXT) break;
2669 if (rr != NULL)
2670 {
2671 int len = (rr->data)[0];
2672 if (len > 511) len = 127;
2673 store_pool = POOL_PERM;
2674 cb->text = string_sprintf("%.*s", len, (const uschar *)(rr->data+1));
2675 store_pool = old_pool;
2676 }
2677 }
2678 }
2679
2680 dnslist_value = addlist;
2681 dnslist_text = cb->text;
2682 return OK;
2683 }
2684
2685/* There was a problem with the DNS lookup */
2686
2687if (cb->rc != DNS_NOMATCH && cb->rc != DNS_NODATA)
2688 {
2689 log_write(L_dnslist_defer, LOG_MAIN,
2690 "DNS list lookup defer (probably timeout) for %s: %s", query,
2691 (defer_return == OK)? US"assumed in list" :
2692 (defer_return == FAIL)? US"assumed not in list" :
2693 US"returned DEFER");
2694 return defer_return;
2695 }
2696
2697/* No entry was found in the DNS; continue for next domain */
2698
2699HDEBUG(D_dnsbl)
2700 {
2701 debug_printf("DNS lookup for %s failed\n", query);
2702 debug_printf("=> that means %s is not listed at %s\n",
2703 keydomain, domain);
2704 }
2705
2706return FAIL;
2707}
2708
2709
2710
2711
059ec3d9
PH
2712/*************************************************
2713* Check host against DNS black lists *
2714*************************************************/
2715
2716/* This function runs checks against a list of DNS black lists, until one
2717matches. Each item on the list can be of the form
2718
2719 domain=ip-address/key
2720
2721The domain is the right-most domain that is used for the query, for example,
2722blackholes.mail-abuse.org. If the IP address is present, there is a match only
2723if the DNS lookup returns a matching IP address. Several addresses may be
2724given, comma-separated, for example: x.y.z=127.0.0.1,127.0.0.2.
2725
2726If no key is given, what is looked up in the domain is the inverted IP address
2727of the current client host. If a key is given, it is used to construct the
2728domain for the lookup. For example,
2729
2730 dsn.rfc-ignorant.org/$sender_address_domain
2731
2732After finding a match in the DNS, the domain is placed in $dnslist_domain, and
2733then we check for a TXT record for an error message, and if found, save its
2734value in $dnslist_text. We also cache everything in a tree, to optimize
2735multiple lookups.
2736
2737Note: an address for testing RBL is 192.203.178.39
2738Note: an address for testing DUL is 192.203.178.4
2739Note: a domain for testing RFCI is example.tld.dsn.rfc-ignorant.org
2740
2741Arguments:
2742 listptr the domain/address/data list
2743
2744Returns: OK successful lookup (i.e. the address is on the list), or
2745 lookup deferred after +include_unknown
2746 FAIL name not found, or no data found for the given type, or
2747 lookup deferred after +exclude_unknown (default)
2748 DEFER lookup failure, if +defer_unknown was set
2749*/
2750
2751int
2752verify_check_dnsbl(uschar **listptr)
2753{
2754int sep = 0;
2755int defer_return = FAIL;
059ec3d9
PH
2756BOOL invert_result = FALSE;
2757uschar *list = *listptr;
2758uschar *domain;
2759uschar *s;
2760uschar buffer[1024];
2761uschar query[256]; /* DNS domain max length */
2762uschar revadd[128]; /* Long enough for IPv6 address */
2763
2764/* Indicate that the inverted IP address is not yet set up */
2765
2766revadd[0] = 0;
2767
0bcb2a0e
PH
2768/* In case this is the first time the DNS resolver is being used. */
2769
2770dns_init(FALSE, FALSE);
2771
059ec3d9
PH
2772/* Loop through all the domains supplied, until something matches */
2773
2774while ((domain = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
2775 {
0bcb2a0e 2776 int rc;
059ec3d9
PH
2777 BOOL frc;
2778 BOOL bitmask = FALSE;
059ec3d9
PH
2779 uschar *iplist;
2780 uschar *key;
059ec3d9
PH
2781
2782 HDEBUG(D_dnsbl) debug_printf("DNS list check: %s\n", domain);
2783
2784 /* Deal with special values that change the behaviour on defer */
2785
2786 if (domain[0] == '+')
2787 {
2788 if (strcmpic(domain, US"+include_unknown") == 0) defer_return = OK;
2789 else if (strcmpic(domain, US"+exclude_unknown") == 0) defer_return = FAIL;
2790 else if (strcmpic(domain, US"+defer_unknown") == 0) defer_return = DEFER;
2791 else
2792 log_write(0, LOG_MAIN|LOG_PANIC, "unknown item in dnslist (ignored): %s",
2793 domain);
2794 continue;
2795 }
2796
2797 /* See if there's explicit data to be looked up */
2798
2799 key = Ustrchr(domain, '/');
2800 if (key != NULL) *key++ = 0;
2801
2802 /* See if there's a list of addresses supplied after the domain name. This is
2803 introduced by an = or a & character; if preceded by ! we invert the result.
2804 */
2805
2806 iplist = Ustrchr(domain, '=');
2807 if (iplist == NULL)
2808 {
2809 bitmask = TRUE;
2810 iplist = Ustrchr(domain, '&');
2811 }
2812
2813 if (iplist != NULL)
2814 {
2815 if (iplist > domain && iplist[-1] == '!')
2816 {
2817 invert_result = TRUE;
2818 iplist[-1] = 0;
2819 }
2820 *iplist++ = 0;
2821 }
2822
2823 /* Check that what we have left is a sensible domain name. There is no reason
2824 why these domains should in fact use the same syntax as hosts and email
2825 domains, but in practice they seem to. However, there is little point in
2826 actually causing an error here, because that would no doubt hold up incoming
2827 mail. Instead, I'll just log it. */
2828
2829 for (s = domain; *s != 0; s++)
2830 {
2831 if (!isalnum(*s) && *s != '-' && *s != '.')
2832 {
2833 log_write(0, LOG_MAIN, "dnslists domain \"%s\" contains "
2834 "strange characters - is this right?", domain);
2835 break;
2836 }
2837 }
2838
8e669ac1 2839 /* If there is no key string, construct the query by adding the domain name
0bcb2a0e 2840 onto the inverted host address, and perform a single DNS lookup. */
8e669ac1 2841
059ec3d9
PH
2842 if (key == NULL)
2843 {
2844 if (sender_host_address == NULL) return FAIL; /* can never match */
2845 if (revadd[0] == 0) invert_address(revadd, sender_host_address);
2846 frc = string_format(query, sizeof(query), "%s%s", revadd, domain);
8e669ac1 2847
0bcb2a0e 2848 if (!frc)
059ec3d9 2849 {
0bcb2a0e
PH
2850 log_write(0, LOG_MAIN|LOG_PANIC, "dnslist query is too long "
2851 "(ignored): %s...", query);
2852 continue;
059ec3d9 2853 }
8e669ac1
PH
2854
2855 rc = one_check_dnsbl(domain, sender_host_address, query, iplist, bitmask,
0bcb2a0e 2856 invert_result, defer_return);
8e669ac1 2857
0bcb2a0e
PH
2858 if (rc == OK)
2859 {
2860 dnslist_domain = string_copy(domain);
8e669ac1 2861 HDEBUG(D_dnsbl) debug_printf("=> that means %s is listed at %s\n",
0bcb2a0e
PH
2862 sender_host_address, domain);
2863 }
8e669ac1 2864
0bcb2a0e 2865 if (rc != FAIL) return rc; /* OK or DEFER */
059ec3d9 2866 }
8e669ac1
PH
2867
2868 /* If there is a key string, it can be a list of domains or IP addresses to
0bcb2a0e 2869 be concatenated with the main domain. */
8e669ac1 2870
059ec3d9
PH
2871 else
2872 {
0bcb2a0e 2873 int keysep = 0;
8e669ac1
PH
2874 BOOL defer = FALSE;
2875 uschar *keydomain;
0bcb2a0e 2876 uschar keybuffer[256];
8e669ac1
PH
2877
2878 while ((keydomain = string_nextinlist(&key, &keysep, keybuffer,
0bcb2a0e 2879 sizeof(keybuffer))) != NULL)
8e669ac1 2880 {
7e66e54d 2881 if (string_is_ip_address(keydomain, NULL) != 0)
059ec3d9 2882 {
0bcb2a0e
PH
2883 uschar keyrevadd[128];
2884 invert_address(keyrevadd, keydomain);
8e669ac1 2885 frc = string_format(query, sizeof(query), "%s%s", keyrevadd, domain);
0bcb2a0e
PH
2886 }
2887 else
8e669ac1 2888 {
0bcb2a0e 2889 frc = string_format(query, sizeof(query), "%s.%s", keydomain, domain);
059ec3d9
PH
2890 }
2891
0bcb2a0e 2892 if (!frc)
059ec3d9 2893 {
0bcb2a0e
PH
2894 log_write(0, LOG_MAIN|LOG_PANIC, "dnslist query is too long "
2895 "(ignored): %s...", query);
2896 continue;
059ec3d9 2897 }
8e669ac1
PH
2898
2899 rc = one_check_dnsbl(domain, keydomain, query, iplist, bitmask,
0bcb2a0e 2900 invert_result, defer_return);
8e669ac1 2901
0bcb2a0e 2902 if (rc == OK)
059ec3d9 2903 {
0bcb2a0e 2904 dnslist_domain = string_copy(domain);
8e669ac1 2905 HDEBUG(D_dnsbl) debug_printf("=> that means %s is listed at %s\n",
0bcb2a0e 2906 keydomain, domain);
8e669ac1 2907 return OK;
059ec3d9 2908 }
8e669ac1 2909
c38d6da9
PH
2910 /* If the lookup deferred, remember this fact. We keep trying the rest
2911 of the list to see if we get a useful result, and if we don't, we return
2912 DEFER at the end. */
059ec3d9 2913
c38d6da9 2914 if (rc == DEFER) defer = TRUE;
0bcb2a0e 2915 } /* continue with next keystring domain/address */
c38d6da9
PH
2916
2917 if (defer) return DEFER;
8e669ac1 2918 }
0bcb2a0e 2919 } /* continue with next dnsdb outer domain */
059ec3d9
PH
2920
2921return FAIL;
2922}
2923
2924/* End of verify.c */