1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Functions for matching strings */
14 /* Argument block for the check_string() function. This is used for general
15 strings, domains, and local parts. */
17 typedef struct check_string_block
{
18 const uschar
*origsubject
; /* caseful; keep these two first, in */
19 const uschar
*subject
; /* step with the block below */
27 /* Argument block for the check_address() function. This is used for whole
30 typedef struct check_address_block
{
31 const uschar
*origaddress
; /* caseful; keep these two first, in */
32 uschar
*address
; /* step with the block above */
35 } check_address_block
;
39 /*************************************************
40 * Generalized string match *
41 *************************************************/
43 /* This function does a single match of a subject against a pattern, and
44 optionally sets up the numeric variables according to what it matched. It is
45 called from match_isinlist() via match_check_list() when scanning a list, and
46 from match_check_string() when testing just a single item. The subject and
47 options arguments are passed in a check_string_block so as to make it easier to
48 pass them through match_check_list.
50 The possible types of pattern are:
52 . regular expression - starts with ^
53 . tail match - starts with *
54 . lookup - starts with search type
55 . if at_is_special is set in the argument block:
56 @ matches the primary host name
57 @[] matches a local IP address in brackets
58 @mx_any matches any domain with an MX to the local host
59 @mx_primary matches any domain with a primary MX to the local host
60 @mx_secondary matches any domain with a secondary MX to the local host
61 . literal - anything else
63 Any of the @mx_xxx options can be followed by "/ignore=<list>" where <list> is
64 a list of IP addresses that are to be ignored (typically 127.0.0.1).
67 arg check_string_block pointer - see below
68 pattern the pattern to be matched
69 valueptr if not NULL, and a lookup is done, return the result here
70 instead of discarding it; else set it to point to NULL
71 error for error messages (not used in this function; it never
74 Contents of the argument block:
75 origsubject the subject in its original casing
76 subject the subject string to be checked, lowercased if caseless
77 expand_setup if < 0, don't set up any numeric expansion variables;
78 if = 0, set $0 to whole subject, and either
79 $1 to what matches * or
80 $1, $2, ... to r.e. bracketed items
81 if > 0, don't set $0, but do set either
82 $n to what matches *, or
83 $n, $n+1, ... to r.e. bracketed items
84 (where n = expand_setup)
85 use_partial if FALSE, override any partial- search types
86 caseless TRUE for caseless matching where possible
87 at_is_special enable special handling of items starting with @
89 Returns: OK if matched
91 DEFER if lookup deferred
95 check_string(void *arg
, const uschar
*pattern
, const uschar
**valueptr
, uschar
**error
)
97 const check_string_block
*cb
= arg
;
98 int search_type
, partial
, affixlen
, starflags
;
99 int expand_setup
= cb
->expand_setup
;
102 uschar
*filename
= NULL
;
103 uschar
*keyquery
, *result
, *semicolon
;
106 error
= error
; /* Keep clever compilers from complaining */
108 if (valueptr
!= NULL
) *valueptr
= NULL
; /* For non-lookup matches */
110 /* For regular expressions, use cb->origsubject rather than cb->subject so that
111 it works if the pattern uses (?-i) to turn off case-independence, overriding
114 s
= string_copy(pattern
[0] == '^' ? cb
->origsubject
: cb
->subject
);
116 /* If required to set up $0, initialize the data but don't turn on by setting
117 expand_nmax until the match is assured. */
120 if (expand_setup
== 0)
122 expand_nstring
[0] = s
;
123 expand_nlength
[0] = Ustrlen(s
);
125 else if (expand_setup
> 0) expand_setup
--;
127 /* Regular expression match: compile, match, and set up $ variables if
130 if (pattern
[0] == '^')
132 const pcre
*re
= regex_must_compile(pattern
, cb
->caseless
, FALSE
);
133 return ((expand_setup
< 0)?
134 pcre_exec(re
, NULL
, CCS s
, Ustrlen(s
), 0, PCRE_EOPT
, NULL
, 0) >= 0
136 regex_match_and_setup(re
, s
, 0, expand_setup
)
143 if (pattern
[0] == '*')
146 int slen
= Ustrlen(s
);
147 int patlen
; /* Sun compiler doesn't like non-constant initializer */
149 patlen
= Ustrlen(++pattern
);
150 if (patlen
> slen
) return FAIL
;
151 yield
= cb
->caseless
?
152 (strncmpic(s
+ slen
- patlen
, pattern
, patlen
) == 0) :
153 (Ustrncmp(s
+ slen
- patlen
, pattern
, patlen
) == 0);
154 if (yield
&& expand_setup
>= 0)
156 expand_nstring
[++expand_setup
] = s
;
157 expand_nlength
[expand_setup
] = slen
- patlen
;
158 expand_nmax
= expand_setup
;
160 return yield
? OK
: FAIL
;
163 /* Match a special item starting with @ if so enabled. On its own, "@" matches
164 the primary host name - implement this by changing the pattern. For the other
165 cases we have to do some more work. If we don't recognize a special pattern,
166 just fall through - the match will fail. */
168 if (cb
->at_is_special
&& pattern
[0] == '@')
172 pattern
= primary_hostname
;
173 goto NOT_AT_SPECIAL
; /* Handle as exact string match */
176 if (Ustrcmp(pattern
, "@[]") == 0)
179 int slen
= Ustrlen(s
);
180 if (s
[0] != '[' && s
[slen
-1] != ']') return FAIL
;
181 for (ip
= host_find_interfaces(); ip
!= NULL
; ip
= ip
->next
)
182 if (Ustrncmp(ip
->address
, s
+1, slen
- 2) == 0
183 && ip
->address
[slen
- 2] == 0)
188 if (strncmpic(pattern
, US
"@mx_", 4) == 0)
194 BOOL removed
= FALSE
;
195 const uschar
*ss
= pattern
+ 4;
196 const uschar
*ignore_target_hosts
= NULL
;
198 if (strncmpic(ss
, US
"any", 3) == 0) ss
+= 3;
199 else if (strncmpic(ss
, US
"primary", 7) == 0)
204 else if (strncmpic(ss
, US
"secondary", 9) == 0)
209 else goto NOT_AT_SPECIAL
;
211 if (strncmpic(ss
, US
"/ignore=", 8) == 0) ignore_target_hosts
= ss
+ 8;
212 else if (*ss
!= 0) goto NOT_AT_SPECIAL
;
218 rc
= host_find_bydns(&h
,
220 HOST_FIND_BY_MX
, /* search only for MX, not SRV or A */
221 NULL
, /* service name not relevant */
222 NULL
, /* srv_fail_domains not relevant */
223 NULL
, /* mx_fail_domains not relevant */
224 NULL
, /* no dnssec request/require XXX ? */
225 NULL
, /* no feedback FQDN */
226 &removed
); /* feedback if local removed */
228 if (rc
== HOST_FIND_AGAIN
)
230 search_error_message
= string_sprintf("DNS lookup of \"%s\" deferred", s
);
234 if (rc
== HOST_FOUND_LOCAL
&& !secy
) return OK
;
235 if (prim
) return FAIL
;
236 return removed
? OK
: FAIL
;
238 /*** The above line used to be the following line, but this is incorrect,
239 because host_find_bydns() may return HOST_NOT_FOUND if it removed some MX
240 hosts, but the remaining ones were non-existent. All we are interested in
241 is whether or not it removed some hosts.
243 return (rc == HOST_FOUND && removed)? OK : FAIL;
248 /* Escape point from code for specials that start with "@" */
252 /* This is an exact string match if there is no semicolon in the pattern. */
254 if ((semicolon
= Ustrchr(pattern
, ';')) == NULL
)
256 BOOL yield
= cb
->caseless
?
257 (strcmpic(s
, pattern
) == 0) : (Ustrcmp(s
, pattern
) == 0);
258 if (yield
&& expand_setup
>= 0) expand_nmax
= expand_setup
;
259 return yield
? OK
: FAIL
;
262 /* Otherwise we have a lookup item. The lookup type, including partial, etc. is
263 the part of the string preceding the semicolon. */
266 search_type
= search_findtype_partial(pattern
, &partial
, &affix
, &affixlen
,
269 if (search_type
< 0) log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "%s",
270 search_error_message
);
272 /* Partial matching is not appropriate for certain lookups (e.g. when looking
273 up user@domain for sender rejection). There's a flag to disable it. */
275 if (!cb
->use_partial
) partial
= -1;
277 /* Set the parameters for the three different kinds of lookup. */
279 keyquery
= semicolon
+ 1;
280 while (isspace(*keyquery
)) keyquery
++;
282 if (mac_islookup(search_type
, lookup_absfilequery
))
285 while (*keyquery
!= 0 && !isspace(*keyquery
)) keyquery
++;
286 filename
= string_copyn(filename
, keyquery
- filename
);
287 while (isspace(*keyquery
)) keyquery
++;
290 else if (!mac_islookup(search_type
, lookup_querystyle
))
296 /* Now do the actual lookup; throw away the data returned unless it was asked
297 for; partial matching is all handled inside search_find(). Note that there is
298 no search_close() because of the caching arrangements. */
300 handle
= search_open(filename
, search_type
, 0, NULL
, NULL
);
301 if (handle
== NULL
) log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "%s",
302 search_error_message
);
303 result
= search_find(handle
, filename
, keyquery
, partial
, affix
, affixlen
,
304 starflags
, &expand_setup
);
306 if (result
== NULL
) return search_find_defer
? DEFER
: FAIL
;
307 if (valueptr
!= NULL
) *valueptr
= result
;
309 expand_nmax
= expand_setup
;
315 /*************************************************
316 * Public interface to check_string() *
317 *************************************************/
319 /* This function is called from several places where is it most convenient to
320 pass the arguments individually. It places them in a check_string_block
321 structure, and then calls check_string().
324 s the subject string to be checked
325 pattern the pattern to check it against
326 expand_setup expansion setup option (see check_string())
327 use_partial if FALSE, override any partial- search types
328 caseless TRUE for caseless matching where possible
329 at_is_special TRUE to recognize @, @[], etc.
330 valueptr if not NULL, and a file lookup was done, return the result
331 here instead of discarding it; else set it to point to NULL
333 Returns: OK if matched
335 DEFER if lookup deferred
339 match_check_string(const uschar
*s
, const uschar
*pattern
, int expand_setup
,
340 BOOL use_partial
, BOOL caseless
, BOOL at_is_special
, const uschar
**valueptr
)
342 check_string_block cb
;
344 cb
.subject
= caseless
? string_copylc(s
) : string_copy(s
);
345 cb
.expand_setup
= expand_setup
;
346 cb
.use_partial
= use_partial
;
347 cb
.caseless
= caseless
;
348 cb
.at_is_special
= at_is_special
;
349 return check_string(&cb
, pattern
, valueptr
, NULL
);
354 /*************************************************
355 * Get key string from check block *
356 *************************************************/
358 /* When caching the data from a lookup for a named list, we have to save the
359 key that was found, because other lookups of different keys on the same list
360 may occur. This function has knowledge of the different lookup types, and
361 extracts the appropriate key.
365 type MCL_STRING, MCL_DOMAIN, MCL_HOST, MCL_ADDRESS, or MCL_LOCALPART
368 static const uschar
*
369 get_check_key(void *arg
, int type
)
376 return ((check_string_block
*)arg
)->subject
;
379 return ((check_host_block
*)arg
)->host_address
;
382 return ((check_address_block
*)arg
)->address
;
384 return US
""; /* In practice, should never happen */
389 /*************************************************
390 * Scan list and run matching function *
391 *************************************************/
393 /* This function scans a list of patterns, and runs a matching function for
394 each item in the list. It is called from the functions that match domains,
395 local parts, hosts, and addresses, because its overall structure is the same in
396 all cases. However, the details of each particular match is different, so it
397 calls back to a given function do perform an actual match.
399 We can't quite keep the different types anonymous here because they permit
400 different special cases. A pity.
402 If a list item starts with !, that implies negation if the subject matches the
403 rest of the item (ignoring white space after the !). The result when the end of
404 the list is reached is FALSE unless the last item on the list is negated, in
405 which case it is TRUE. A file name in the list causes its lines to be
406 interpolated as if items in the list. An item starting with + is a named
407 sublist, obtained by searching the tree pointed to by anchorptr, with possible
408 cached match results in cache_bits.
411 listptr pointer to the pointer to the list
412 sep separator character for string_nextinlist();
413 normally zero for a standard list;
414 sometimes UCHAR_MAX+1 for single items;
415 anchorptr -> tree of named items, or NULL if no named items
416 cache_ptr pointer to pointer to cache bits for named items, or
417 pointer to NULL if not caching; may get set NULL if an
418 uncacheable named list is encountered
419 func function to call back to do one test
420 arg pointer to pass to the function; the string to be matched is
421 in the structure it points to
422 type MCL_STRING, MCL_DOMAIN, MCL_HOST, MCL_ADDRESS, or MCL_LOCALPART
423 these are used for some special handling
424 MCL_NOEXPAND (whose value is greater than any of them) may
425 be added to any value to suppress expansion of the list
426 name string to use in debugging info
427 valueptr where to pass back data from a lookup
429 Returns: OK if matched a non-negated item
430 OK if hit end of list after a negated item
431 FAIL if expansion force-failed
432 FAIL if matched a negated item
433 FAIL if hit end of list after a non-negated item
434 DEFER if a something deferred or expansion failed
438 match_check_list(const uschar
**listptr
, int sep
, tree_node
**anchorptr
,
439 unsigned int **cache_ptr
, int (*func
)(void *,const uschar
*,const uschar
**,uschar
**),
440 void *arg
, int type
, const uschar
*name
, const uschar
**valueptr
)
443 unsigned int *original_cache_bits
= *cache_ptr
;
444 BOOL include_unknown
= FALSE
;
445 BOOL ignore_unknown
= FALSE
;
446 BOOL include_defer
= FALSE
;
447 BOOL ignore_defer
= FALSE
;
453 /* Save time by not scanning for the option name when we don't need it. */
457 uschar
*listname
= readconf_find_option(listptr
);
458 if (listname
[0] != 0) ot
= string_sprintf("%s in %s?", name
, listname
);
461 /* If the list is empty, the answer is no. Skip the debugging output for
466 HDEBUG(D_lists
) if (ot
) debug_printf("%s no (option unset)\n", ot
);
470 /* Expand the list before we scan it. A forced expansion gives the answer
471 "not in list"; other expansion errors cause DEFER to be returned. However,
472 if the type value is greater than or equal to than MCL_NOEXPAND, do not expand
475 if (type
>= MCL_NOEXPAND
)
478 type
-= MCL_NOEXPAND
; /* Remove the "no expand" flag */
482 /* If we are searching a domain list, and $domain is not set, set it to the
483 subject that is being sought for the duration of the expansion. */
485 if (type
== MCL_DOMAIN
&& !deliver_domain
)
487 check_string_block
*cb
= (check_string_block
*)arg
;
488 deliver_domain
= string_copy(cb
->subject
);
489 list
= expand_cstring(*listptr
);
490 deliver_domain
= NULL
;
493 list
= expand_cstring(*listptr
);
497 if (expand_string_forcedfail
)
499 HDEBUG(D_lists
) debug_printf("expansion of \"%s\" forced failure: "
500 "assume not in this list\n", *listptr
);
503 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to expand \"%s\" while checking "
504 "a list: %s", *listptr
, expand_string_message
);
509 /* For an unnamed list, use the expanded version in comments */
511 HDEBUG(D_any
) if (ot
== NULL
) ot
= string_sprintf("%s in \"%s\"?", name
, list
);
513 /* Now scan the list and process each item in turn, until one of them matches,
514 or we hit an error. */
516 while ((sss
= string_nextinlist(&list
, &sep
, buffer
, sizeof(buffer
))))
520 /* Address lists may contain +caseful, to restore caseful matching of the
521 local part. We have to know the layout of the control block, unfortunately.
522 The lower cased address is in a temporary buffer, so we just copy the local
523 part back to the start of it (if a local part exists). */
525 if (type
== MCL_ADDRESS
)
527 if (Ustrcmp(ss
, "+caseful") == 0)
529 check_address_block
*cb
= (check_address_block
*)arg
;
530 uschar
*at
= Ustrrchr(cb
->origaddress
, '@');
533 Ustrncpy(cb
->address
, cb
->origaddress
, at
- cb
->origaddress
);
534 cb
->caseless
= FALSE
;
539 /* Similar processing for local parts */
541 else if (type
== MCL_LOCALPART
)
543 if (Ustrcmp(ss
, "+caseful") == 0)
545 check_string_block
*cb
= (check_string_block
*)arg
;
546 Ustrcpy(cb
->subject
, cb
->origsubject
);
547 cb
->caseless
= FALSE
;
552 /* If the host item is "+include_unknown" or "+ignore_unknown", remember it
553 in case there's a subsequent failed reverse lookup. There is similar
554 processing for "defer". */
556 else if (type
== MCL_HOST
&& *ss
== '+')
558 if (Ustrcmp(ss
, "+include_unknown") == 0)
560 include_unknown
= TRUE
;
561 ignore_unknown
= FALSE
;
564 if (Ustrcmp(ss
, "+ignore_unknown") == 0)
566 ignore_unknown
= TRUE
;
567 include_unknown
= FALSE
;
570 if (Ustrcmp(ss
, "+include_defer") == 0)
572 include_defer
= TRUE
;
573 ignore_defer
= FALSE
;
576 if (Ustrcmp(ss
, "+ignore_defer") == 0)
579 include_defer
= FALSE
;
584 /* Starting with ! specifies a negative item. It is theoretically possible
585 for a local part to start with !. In that case, a regex has to be used. */
590 while (isspace((*(++ss
))));
595 /* If the item does not begin with '/', it might be a + item for a named
596 list. Otherwise, it is just a single list entry that has to be matched.
597 We recognize '+' only when supplied with a tree of named lists. */
601 if (*ss
== '+' && anchorptr
)
606 unsigned int *use_cache_bits
= original_cache_bits
;
607 uschar
*cached
= US
"";
611 if (!(t
= tree_search(*anchorptr
, ss
+1)))
613 log_write(0, LOG_MAIN
|LOG_PANIC
, "unknown named%s list \"%s\"",
614 type
== MCL_DOMAIN
? " domain" :
615 type
== MCL_HOST
? " host" :
616 type
== MCL_ADDRESS
? " address" :
617 type
== MCL_LOCALPART
? " local part" : "",
623 /* If the list number is negative, it means that this list is not
624 cacheable because it contains expansion items. */
626 if (nb
->number
< 0) use_cache_bits
= NULL
;
628 /* If we have got a cache pointer, get the bits. This is not an "else"
629 because the pointer may be NULL from the start if caching is not
634 offset
= (nb
->number
)/16;
635 shift
= ((nb
->number
)%16)*2;
636 bits
= use_cache_bits
[offset
] & (3 << shift
);
639 /* Not previously tested or no cache - run the full test */
643 switch (match_check_list(&(nb
->string
), 0, anchorptr
, &use_cache_bits
,
644 func
, arg
, type
, name
, valueptr
))
646 case OK
: bits
= 1; break;
647 case FAIL
: bits
= 3; break;
648 case DEFER
: goto DEFER_RETURN
;
651 /* If this list was uncacheable, or a sublist turned out to be
652 uncacheable, the value of use_cache_bits will now be NULL, even if it
653 wasn't before. Ensure that this is passed up to the next level.
654 Otherwise, remember the result of the search in the cache. */
660 use_cache_bits
[offset
] |= bits
<< shift
;
664 int old_pool
= store_pool
;
665 namedlist_cacheblock
*p
;
667 /* Cached data for hosts persists over more than one message,
668 so we use the permanent store pool */
670 store_pool
= POOL_PERM
;
671 p
= store_get(sizeof(namedlist_cacheblock
));
672 p
->key
= string_copy(get_check_key(arg
, type
));
675 p
->data
= *valueptr
? string_copy(*valueptr
) : NULL
;
676 store_pool
= old_pool
;
678 p
->next
= nb
->cache_data
;
681 DEBUG(D_lists
) debug_printf("data from lookup saved for "
682 "cache for %s: %s\n", ss
, *valueptr
);
687 /* Previously cached; to find a lookup value, search a chain of values
688 and compare keys. Typically, there is only one such, but it is possible
689 for different keys to have matched the same named list. */
693 DEBUG(D_lists
) debug_printf("cached %s match for %s\n",
694 ((bits
& (-bits
)) == bits
)? "yes" : "no", ss
);
696 cached
= US
" - cached";
699 const uschar
*key
= get_check_key(arg
, type
);
700 namedlist_cacheblock
*p
;
701 for (p
= nb
->cache_data
; p
; p
= p
->next
)
702 if (Ustrcmp(key
, p
->key
) == 0)
707 DEBUG(D_lists
) debug_printf("cached lookup data = %s\n", *valueptr
);
711 /* Result of test is indicated by value in bits. For each test, we
712 have 00 => untested, 01 => tested yes, 11 => tested no. */
714 if ((bits
& (-bits
)) == bits
) /* Only one of the two bits is set */
716 HDEBUG(D_lists
) debug_printf("%s %s (matched \"%s\"%s)\n", ot
,
717 (yield
== OK
)? "yes" : "no", sss
, cached
);
722 /* Run the provided function to do the individual test. */
726 uschar
* error
= NULL
;
727 switch ((func
)(arg
, ss
, valueptr
, &error
))
730 HDEBUG(D_lists
) debug_printf("%s %s (matched \"%s\")\n", ot
,
731 (yield
== OK
)? "yes" : "no", sss
);
736 error
= string_sprintf("DNS lookup of \"%s\" deferred", ss
);
739 HDEBUG(D_lists
) debug_printf("%s: item ignored by +ignore_defer\n",
745 log_write(0, LOG_MAIN
, "%s: accepted by +include_defer", error
);
748 if (!search_error_message
) search_error_message
= error
;
751 /* The ERROR return occurs when checking hosts, when either a forward
752 or reverse lookup has failed. It can also occur in a match_ip list if a
753 non-IP address item is encountered. The error string gives details of
759 HDEBUG(D_lists
) debug_printf("%s: item ignored by +ignore_unknown\n",
764 HDEBUG(D_lists
) debug_printf("%s %s (%s)\n", ot
,
765 include_unknown
? "yes":"no", error
);
766 if (!include_unknown
)
768 if (LOGGING(unknown_in_list
))
769 log_write(0, LOG_MAIN
, "list matching forced to fail: %s", error
);
772 log_write(0, LOG_MAIN
, "%s: accepted by +include_unknown", error
);
779 /* If the item is a file name, we read the file and do a match attempt
780 on each line in the file, including possibly more negation processing. */
784 int file_yield
= yield
; /* In case empty file */
785 uschar
* filename
= ss
;
786 FILE * f
= Ufopen(filename
, "rb");
787 uschar filebuffer
[1024];
789 /* ot will be null in non-debugging cases, and anyway, we get better
790 wording by reworking it. */
794 uschar
* listname
= readconf_find_option(listptr
);
795 if (listname
[0] == 0)
796 listname
= string_sprintf("\"%s\"", *listptr
);
797 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "%s",
798 string_open_failed(errno
, "%s when checking %s", sss
, listname
));
801 /* Trailing comments are introduced by #, but in an address list or local
802 part list, the # must be preceded by white space or the start of the line,
803 because the # character is a legal character in local parts. */
805 while (Ufgets(filebuffer
, sizeof(filebuffer
), f
) != NULL
)
808 uschar
*sss
= filebuffer
;
810 while ((ss
= Ustrchr(sss
, '#')) != NULL
)
812 if ((type
!= MCL_ADDRESS
&& type
!= MCL_LOCALPART
) ||
813 ss
== filebuffer
|| isspace(ss
[-1]))
821 ss
= filebuffer
+ Ustrlen(filebuffer
); /* trailing space */
822 while (ss
> filebuffer
&& isspace(ss
[-1])) ss
--;
826 while (isspace(*ss
)) ss
++; /* leading space */
828 if (*ss
== 0) continue; /* ignore empty */
830 file_yield
= yield
; /* positive yield */
831 sss
= ss
; /* for debugging */
833 if (*ss
== '!') /* negation */
835 file_yield
= (file_yield
== OK
)? FAIL
: OK
;
836 while (isspace((*(++ss
))));
839 switch ((func
)(arg
, ss
, valueptr
, &error
))
843 HDEBUG(D_lists
) debug_printf("%s %s (matched \"%s\" in %s)\n", ot
,
844 yield
== OK
? "yes" : "no", sss
, filename
);
849 error
= string_sprintf("DNS lookup of %s deferred", ss
);
852 HDEBUG(D_lists
) debug_printf("%s: item ignored by +ignore_defer\n",
859 log_write(0, LOG_MAIN
, "%s: accepted by +include_defer", error
);
864 case ERROR
: /* host name lookup failed - this can only */
865 if (ignore_unknown
) /* be for an incoming host (not outgoing) */
867 HDEBUG(D_lists
) debug_printf("%s: item ignored by +ignore_unknown\n",
872 HDEBUG(D_lists
) debug_printf("%s %s (%s)\n", ot
,
873 include_unknown
? "yes":"no", error
);
875 if (!include_unknown
)
877 if (LOGGING(unknown_in_list
))
878 log_write(0, LOG_MAIN
, "list matching forced to fail: %s", error
);
881 log_write(0, LOG_MAIN
, "%s: accepted by +include_unknown", error
);
887 /* At the end of the file, leave the yield setting at the final setting
888 for the file, in case this is the last item in the list. */
893 } /* Loop for the next item on the top-level list */
895 /* End of list reached: if the last item was negated yield OK, else FAIL. */
898 debug_printf("%s %s (end of list)\n", ot
, yield
== OK
? "no":"yes");
899 return yield
== OK
? FAIL
: OK
;
901 /* Something deferred */
904 HDEBUG(D_lists
) debug_printf("%s list match deferred for %s\n", ot
, sss
);
909 /*************************************************
910 * Match in colon-separated list *
911 *************************************************/
913 /* This function is used for domain lists and local part lists. It is not used
914 for host lists or address lists, which have additional interpretation of the
915 patterns. Some calls of it set sep > UCHAR_MAX in order to use its matching
916 facilities on single items. When this is done, it arranges to set the numerical
917 variables as a result of the match.
919 This function is now just a short interface to match_check_list(), which does
920 list scanning in a general way. A good compiler will optimize the tail
924 s string to search for
925 listptr ptr to ptr to colon separated list of patterns, or NULL
926 sep a separator value for the list (see string_nextinlist())
927 anchorptr ptr to tree for named items, or NULL if no named items
928 cache_bits ptr to cache_bits for ditto, or NULL if not caching
929 type MCL_DOMAIN when matching a domain list
930 MCL_LOCALPART when matching a local part list (address lists
931 have their own function)
932 MCL_STRING for others (e.g. list of ciphers)
933 MCL_NOEXPAND (whose value is greater than any of them) may
934 be added to any value to suppress expansion of the list
935 caseless TRUE for (mostly) caseless matching - passed directly to
937 valueptr pointer to where any lookup data is to be passed back,
938 or NULL (just passed on to match_check_string)
940 Returns: OK if matched a non-negated item
941 OK if hit end of list after a negated item
942 FAIL if expansion force-failed
943 FAIL if matched a negated item
944 FAIL if hit end of list after a non-negated item
945 DEFER if a lookup deferred
949 match_isinlist(const uschar
*s
, const uschar
**listptr
, int sep
,
950 tree_node
**anchorptr
,
951 unsigned int *cache_bits
, int type
, BOOL caseless
, const uschar
**valueptr
)
953 unsigned int *local_cache_bits
= cache_bits
;
954 check_string_block cb
;
956 cb
.subject
= caseless
? string_copylc(s
) : string_copy(s
);
957 cb
.expand_setup
= (sep
> UCHAR_MAX
)? 0 : -1;
958 cb
.use_partial
= TRUE
;
959 cb
.caseless
= caseless
;
960 cb
.at_is_special
= (type
== MCL_DOMAIN
|| type
== MCL_DOMAIN
+ MCL_NOEXPAND
);
961 if (valueptr
!= NULL
) *valueptr
= NULL
;
962 return match_check_list(listptr
, sep
, anchorptr
, &local_cache_bits
,
963 check_string
, &cb
, type
, s
, valueptr
);
968 /*************************************************
969 * Match address to single address-list item *
970 *************************************************/
972 /* This function matches an address to an item from an address list. It is
973 called from match_address_list() via match_check_list(). That is why most of
974 its arguments are in an indirect block.
977 arg the argument block (see below)
978 pattern the pattern to match
979 valueptr where to return a value
980 error for error messages (not used in this function; it never
983 The argument block contains:
984 address the start of the subject address; when called from retry.c
985 it may be *@domain if the local part isn't relevant
986 origaddress the original, un-case-forced address (not used here, but used
987 in match_check_list() when +caseful is encountered)
988 expand_setup controls setting up of $n variables
989 caseless TRUE for caseless local part matching
991 Returns: OK for a match
993 DEFER if a lookup deferred
997 check_address(void *arg
, const uschar
*pattern
, const uschar
**valueptr
, uschar
**error
)
999 check_address_block
*cb
= (check_address_block
*)arg
;
1000 check_string_block csb
;
1003 unsigned int *null
= NULL
;
1004 const uschar
*listptr
;
1005 uschar
*subject
= cb
->address
;
1007 uschar
*pdomain
, *sdomain
;
1009 error
= error
; /* Keep clever compilers from complaining */
1011 DEBUG(D_lists
) debug_printf("address match test: subject=%s pattern=%s\n",
1014 /* Find the subject's domain */
1016 sdomain
= Ustrrchr(subject
, '@');
1018 /* The only case where a subject may not have a domain is if the subject is
1019 empty. Otherwise, a subject with no domain is a serious configuration error. */
1021 if (sdomain
== NULL
&& *subject
!= 0)
1023 log_write(0, LOG_MAIN
|LOG_PANIC
, "no @ found in the subject of an "
1024 "address list match: subject=\"%s\" pattern=\"%s\"", subject
, pattern
);
1028 /* Handle a regular expression, which must match the entire incoming address.
1029 This may be the empty address. */
1031 if (*pattern
== '^')
1032 return match_check_string(subject
, pattern
, cb
->expand_setup
, TRUE
,
1033 cb
->caseless
, FALSE
, NULL
);
1035 /* Handle a pattern that is just a lookup. Skip over possible lookup names
1036 (letters, digits, hyphens). Skip over a possible * or *@ at the end. Then we
1037 must have a semicolon for it to be a lookup. */
1039 for (s
= pattern
; isalnum(*s
) || *s
== '-'; s
++);
1043 /* If it is a straight lookup, do a lookup for the whole address. This may be
1044 the empty address. Partial matching doesn't make sense here, so we ignore it,
1045 but write a panic log entry. However, *@ matching will be honoured. */
1049 if (Ustrncmp(pattern
, "partial-", 8) == 0)
1050 log_write(0, LOG_MAIN
|LOG_PANIC
, "partial matching is not applicable to "
1051 "whole-address lookups: ignored \"partial-\" in \"%s\"", pattern
);
1052 return match_check_string(subject
, pattern
, -1, FALSE
, cb
->caseless
, FALSE
,
1056 /* For the remaining cases, an empty subject matches only an empty pattern,
1057 because other patterns expect to have a local part and a domain to match
1060 if (*subject
== 0) return (*pattern
== 0)? OK
: FAIL
;
1062 /* If the pattern starts with "@@" we have a split lookup, where the domain is
1063 looked up to obtain a list of local parts. If the subject's local part is just
1064 "*" (called from retry) the match always fails. */
1066 if (pattern
[0] == '@' && pattern
[1] == '@')
1071 uschar buffer
[1024];
1073 if (sdomain
== subject
+ 1 && *subject
== '*') return FAIL
;
1075 /* Loop for handling chains. The last item in any list may be of the form
1076 ">name" in order to chain on to another list. */
1078 for (key
= sdomain
+ 1; key
!= NULL
&& watchdog
-- > 0; )
1082 if ((rc
= match_check_string(key
, pattern
+ 2, -1, TRUE
, FALSE
, FALSE
,
1083 CUSS
&list
)) != OK
) return rc
;
1085 /* Check for chaining from the last item; set up the next key if one
1088 ss
= Ustrrchr(list
, ':');
1089 if (ss
== NULL
) ss
= list
; else ss
++;
1090 while (isspace(*ss
)) ss
++;
1094 while (isspace(*ss
)) ss
++;
1095 key
= string_copy(ss
);
1099 /* Look up the local parts provided by the list; negation is permitted.
1100 If a local part has to begin with !, a regex can be used. */
1102 while ((ss
= string_nextinlist(CUSS
&list
, &sep
, buffer
, sizeof(buffer
))))
1109 while (isspace((*(++ss
))));
1111 else local_yield
= OK
;
1114 rc
= match_check_string(subject
, ss
, -1, TRUE
, cb
->caseless
, FALSE
,
1129 /* End of chain loop; panic if too many times */
1132 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "Loop detected in lookup of "
1133 "local part of %s in %s", subject
, pattern
);
1135 /* Otherwise the local part check has failed, so the whole match
1142 /* We get here if the pattern is not a lookup or a regular expression. If it
1143 contains an @ there is both a local part and a domain. */
1145 pdomain
= Ustrrchr(pattern
, '@');
1146 if (pdomain
!= NULL
)
1150 /* If the domain in the pattern is empty or one of the special cases [] or
1151 mx_{any,primary,secondary}, and the local part in the pattern ends in "@",
1152 we have a pattern of the form <something>@@, <something>@@[], or
1153 <something>@@mx_{any,primary,secondary}. These magic "domains" are
1154 automatically interpreted in match_check_string. We just need to arrange that
1155 the leading @ is included in the domain. */
1157 if (pdomain
> pattern
&& pdomain
[-1] == '@' &&
1159 Ustrcmp(pdomain
+1, "[]") == 0 ||
1160 Ustrcmp(pdomain
+1, "mx_any") == 0 ||
1161 Ustrcmp(pdomain
+1, "mx_primary") == 0 ||
1162 Ustrcmp(pdomain
+1, "mx_secondary") == 0))
1165 pllen
= pdomain
- pattern
;
1166 sllen
= sdomain
- subject
;
1168 /* Compare the local parts in the subject and the pattern */
1170 if (*pattern
== '*')
1172 int cllen
= pllen
- 1;
1173 if (sllen
< cllen
) return FAIL
;
1176 if (strncmpic(subject
+sllen
-cllen
, pattern
+ 1, cllen
) != 0)
1181 if (Ustrncmp(subject
+sllen
-cllen
, pattern
+ 1, cllen
) != 0)
1184 if (cb
->expand_setup
> 0)
1186 expand_nstring
[cb
->expand_setup
] = subject
;
1187 expand_nlength
[cb
->expand_setup
] = sllen
- cllen
;
1193 if (sllen
!= pllen
) return FAIL
;
1196 if (strncmpic(subject
, pattern
, sllen
) != 0) return FAIL
;
1200 if (Ustrncmp(subject
, pattern
, sllen
) != 0) return FAIL
;
1205 /* If the local part matched, or was not being checked, check the domain using
1206 the generalized function, which supports file lookups (which may defer). The
1207 original code read as follows:
1209 return match_check_string(sdomain + 1,
1210 (pdomain == NULL)? pattern : pdomain + 1,
1211 cb->expand_setup + expand_inc, TRUE, cb->caseless, TRUE, NULL);
1213 This supported only literal domains and *.x.y patterns. In order to allow for
1214 named domain lists (so that you can right, for example, "senders=+xxxx"), it
1215 was changed to use the list scanning function. */
1217 csb
.origsubject
= sdomain
+ 1;
1218 csb
.subject
= (cb
->caseless
)? string_copylc(sdomain
+1) : string_copy(sdomain
+1);
1219 csb
.expand_setup
= cb
->expand_setup
+ expand_inc
;
1220 csb
.use_partial
= TRUE
;
1221 csb
.caseless
= cb
->caseless
;
1222 csb
.at_is_special
= TRUE
;
1224 listptr
= (pdomain
== NULL
)? pattern
: pdomain
+ 1;
1225 if (valueptr
!= NULL
) *valueptr
= NULL
;
1227 return match_check_list(
1228 &listptr
, /* list of one item */
1229 UCHAR_MAX
+1, /* impossible separator; single item */
1230 &domainlist_anchor
, /* it's a domain list */
1231 &null
, /* ptr to NULL means no caching */
1232 check_string
, /* the function to do one test */
1233 &csb
, /* its data */
1234 MCL_DOMAIN
+ MCL_NOEXPAND
, /* domain list; don't expand */
1235 csb
.subject
, /* string for messages */
1236 valueptr
); /* where to pass back lookup data */
1242 /*************************************************
1243 * Test whether address matches address list *
1244 *************************************************/
1246 /* This function is given an address and a list of things to match it against.
1247 The list may contain individual addresses, regular expressions, lookup
1248 specifications, and indirection via bare files. Negation is supported. The
1249 address to check can consist of just a domain, which will then match only
1250 domain items or items specified as *@domain.
1252 Domains are always lower cased before the match. Local parts are also lower
1253 cased unless "caseless" is false. The work of actually scanning the list is
1254 done by match_check_list(), with an appropriate block of arguments and a
1255 callback to check_address(). During caseless matching, it will recognize
1256 +caseful and revert to caseful matching.
1259 address address to test
1260 caseless TRUE to start in caseless state
1261 expand TRUE to allow list expansion
1262 listptr list to check against
1263 cache_bits points to cache bits for named address lists, or NULL
1264 expand_setup controls setting up of $n variables - passed through
1265 to check_address (q.v.)
1266 sep separator character for the list;
1267 may be 0 to get separator from the list;
1268 may be UCHAR_MAX+1 for one-item list
1269 valueptr where to return a lookup value, or NULL
1271 Returns: OK for a positive match, or end list after a negation;
1272 FAIL for a negative match, or end list after non-negation;
1273 DEFER if a lookup deferred
1277 match_address_list(const uschar
*address
, BOOL caseless
, BOOL expand
,
1278 const uschar
**listptr
, unsigned int *cache_bits
, int expand_setup
, int sep
,
1279 const uschar
**valueptr
)
1282 check_address_block ab
;
1283 unsigned int *local_cache_bits
= cache_bits
;
1285 /* RFC 2505 recommends that for spam checking, local parts should be caselessly
1286 compared. Therefore, Exim now forces the entire address into lower case here,
1287 provided that "caseless" is set. (It is FALSE for calls for matching rewriting
1288 patterns.) Otherwise just the domain is lower cases. A magic item "+caseful" in
1289 the list can be used to restore a caseful copy of the local part from the
1290 original address. */
1292 sprintf(CS big_buffer
, "%.*s", big_buffer_size
- 1, address
);
1293 for (p
= big_buffer
+ Ustrlen(big_buffer
) - 1; p
>= big_buffer
; p
--)
1295 if (!caseless
&& *p
== '@') break;
1299 /* If expand_setup is zero, we need to set up $0 to the whole thing, in
1300 case there is a match. Can't use the built-in facilities of match_check_string
1301 (via check_address), as we may just be calling that for part of the address
1304 if (expand_setup
== 0)
1306 expand_nstring
[0] = string_copy(address
);
1307 expand_nlength
[0] = Ustrlen(address
);
1311 /* Set up the data to be passed ultimately to check_address. */
1313 ab
.origaddress
= address
;
1314 ab
.address
= big_buffer
;
1315 ab
.expand_setup
= expand_setup
;
1316 ab
.caseless
= caseless
;
1318 return match_check_list(listptr
, sep
, &addresslist_anchor
, &local_cache_bits
,
1319 check_address
, &ab
, MCL_ADDRESS
+ (expand
? 0:MCL_NOEXPAND
), address
,
1323 /* Simpler version of match_address_list; always caseless, expanding,
1324 no cache bits, no value-return.
1327 address address to test
1328 listptr list to check against
1329 sep separator character for the list;
1330 may be 0 to get separator from the list;
1331 may be UCHAR_MAX+1 for one-item list
1333 Returns: OK for a positive match, or end list after a negation;
1334 FAIL for a negative match, or end list after non-negation;
1335 DEFER if a lookup deferred
1339 match_address_list_basic(const uschar
*address
, const uschar
**listptr
, int sep
)
1341 return match_address_list(address
, TRUE
, TRUE
, listptr
, NULL
, -1, sep
, NULL
);
1344 /* End of match.c */