Revert introduction of alloc_insecure_tainted_data
[exim.git] / src / src / search.c
1 /*************************************************
2 *     Exim - an Internet mail transport agent    *
3 *************************************************/
4
5 /* Copyright (c) University of Cambridge 1995 - 2015 */
6 /* Copyright (c) The Exim Maintainers 2020 - 2021 */
7 /* See the file NOTICE for conditions of use and distribution. */
8
9 /* A set of functions to search databases in various formats. An open
10 database is represented by a void * value which is returned from a lookup-
11 specific "open" function. These are now all held in individual modules in the
12 lookups subdirectory and the functions here form a generic interface.
13
14 Caching is used to improve performance. Open files are cached until a tidyup
15 function is called, and for each file the result of the last lookup is cached.
16 However, if too many files are opened, some of those that are not in use have
17 to be closed. Those open items that use real files are kept on a LRU chain to
18 help with this.
19
20 All the data is held in permanent store so as to be independent of the stacking
21 pool that is reset from time to time. In fact, we use malloc'd store so that it
22 can be freed when the caches are tidied up. It isn't actually clear whether
23 this is a benefit or not, to be honest. */
24
25 #include "exim.h"
26
27
28 /* Tree in which to cache open files until tidyup called. */
29
30 static tree_node *search_tree = NULL;
31
32 /* Two-way chain of open databases that use real files. This is maintained in
33 recently-used order for the purposes of closing the least recently used when
34 too many files are open. */
35
36 static tree_node *open_top = NULL;
37 static tree_node *open_bot = NULL;
38
39 /* Count of open databases that use real files */
40
41 static int open_filecount = 0;
42
43 /* Allow us to reset store used for lookups and lookup caching */
44
45 static rmark search_reset_point = NULL;
46
47
48
49 /*************************************************
50 *      Validate a plain lookup type name         *
51 *************************************************/
52
53 /* Only those names that are recognized and whose code is included in the
54 binary give an OK response. Use a binary chop search now that the list has got
55 so long.
56
57 Arguments:
58   name       lookup type name - not necessarily zero terminated (e.g. dbm*)
59   len        length of the name
60
61 Returns:     +ve => valid lookup name; value is offset in lookup_list
62              -ve => invalid name; message in search_error_message.
63 */
64
65 int
66 search_findtype(const uschar * name, int len)
67 {
68 for (int bot = 0, top = lookup_list_count; top > bot; )
69   {
70   int mid = (top + bot)/2;
71   int c = Ustrncmp(name, lookup_list[mid]->name, len);
72
73   /* If c == 0 we have matched the incoming name with the start of the search
74   type name. However, some search types are substrings of others (e.g. nis and
75   nisplus) so we need to check that the lengths are the same. The length of the
76   type name cannot be shorter (else c would not be 0); if it is not equal it
77   must be longer, and in that case, the incoming name comes before the name we
78   are testing. By leaving c == 0 when the lengths are different, and doing a
79   > 0 test below, this all falls out correctly. */
80
81   if (c == 0 && Ustrlen(lookup_list[mid]->name) == len)
82     {
83     if (lookup_list[mid]->find != NULL) return mid;
84     search_error_message  = string_sprintf("lookup type \"%.*s\" is not "
85       "available (not in the binary - check buildtime LOOKUP configuration)",
86       len, name);
87     return -1;
88     }
89
90   if (c > 0) bot = mid + 1; else top = mid;
91   }
92
93 search_error_message = string_sprintf("unknown lookup type \"%.*s\"", len, name);
94 return -1;
95 }
96
97
98
99 /*************************************************
100 *       Validate a full lookup type name         *
101 *************************************************/
102
103 /* This function recognizes the "partial-" prefix and also terminating * and *@
104 suffixes.
105
106 Arguments:
107   name         the full lookup type name
108   ptypeptr     where to put the partial type
109                  after subtraction of 1024 or 2048:
110                    negative     => no partial matching
111                    non-negative => minimum number of non-wild components
112   ptypeaff     where to put a pointer to the affix
113                  the affix is within name if supplied therein
114                  otherwise it's a literal string
115   afflen       the length of the affix
116   starflags    where to put the SEARCH_STAR and SEARCH_STARAT flags
117   opts         where to put the options
118
119 Returns:     +ve => valid lookup name; value is offset in lookup_list
120              -ve => invalid name; message in search_error_message.
121 */
122
123 int
124 search_findtype_partial(const uschar *name, int *ptypeptr, const uschar **ptypeaff,
125   int *afflen, int *starflags, const uschar ** opts)
126 {
127 int len, stype;
128 int pv = -1;
129 const uschar *ss = name;
130 const uschar * t;
131
132 *starflags = 0;
133 *ptypeaff = NULL;
134
135 /* Check for a partial matching type. It must start with "partial", optionally
136 followed by a sequence of digits. If this is followed by "-", the affix is the
137 default "*." string. Otherwise we expect an affix in parentheses. Affixes are a
138 limited number of characters, not including parens. */
139
140 if (Ustrncmp(name, "partial", 7) == 0)
141   {
142   ss += 7;
143   if (isdigit (*ss))
144     {
145     pv = 0;
146     while (isdigit(*ss)) pv = pv*10 + *ss++ - '0';
147     }
148   else pv = 2;         /* Default number of wild components */
149
150   if (*ss == '(')
151     {
152     *ptypeaff = ++ss;
153     while (ispunct(*ss) && *ss != ')') ss++;
154     if (*ss != ')') goto BAD_TYPE;
155     *afflen = ss++ - *ptypeaff;
156     }
157   else if (*ss++ == '-')
158     {
159     *ptypeaff = US "*.";
160     *afflen = 2;
161     }
162   else
163     {
164     BAD_TYPE:
165     search_error_message = string_sprintf("format error in lookup type \"%s\"",
166       name);
167     return -1;
168     }
169   }
170
171 /* Now we are left with a lookup name, possibly followed by * or *@,
172 and then by options starting with a "," */
173
174 len = Ustrlen(ss);
175 if ((t = Ustrchr(ss, '*')))
176   {
177   len = t - ss;
178   *starflags |= (t[1] == '@' ? SEARCH_STARAT : SEARCH_STAR);
179   }
180 else
181   t = ss;
182
183 if ((t = Ustrchr(t, ',')))
184   {
185   int l = t - ss;
186   if (l < len) len = l;
187   *opts = string_copy(t+1);
188   }
189 else
190   *opts = NULL;
191
192 /* Check for the individual search type. Only those that are actually in the
193 binary are valid. For query-style types, "partial" and default types are
194 erroneous. */
195
196 stype = search_findtype(ss, len);
197 if (stype >= 0 && mac_islookup(stype, lookup_querystyle))
198   {
199   if (pv >= 0)
200     {
201     search_error_message = string_sprintf("\"partial\" is not permitted "
202       "for lookup type \"%s\"", ss);
203     return -1;
204     }
205   if ((*starflags & (SEARCH_STAR|SEARCH_STARAT)) != 0)
206     {
207     search_error_message = string_sprintf("defaults using \"*\" or \"*@\" are "
208       "not permitted for lookup type \"%s\"", ss);
209     return -1;
210     }
211   }
212
213 *ptypeptr = pv;
214 return stype;
215 }
216
217
218 /* Set the parameters for the three different kinds of lookup.
219 Arguments:
220  search_type    the search-type code
221  search         the search-type string
222  query          argument for the search; filename or query
223  fnamep         pointer to return filename
224  opts           options
225
226 Return: keyquery        the search-type (for single-key) or query (for query-type)
227  */
228 uschar *
229 search_args(int search_type, uschar * search, uschar * query, uschar ** fnamep,
230   const uschar * opts)
231 {
232 Uskip_whitespace(&query);
233 if (mac_islookup(search_type, lookup_absfilequery))
234   {                                     /* query-style but with file (sqlite) */
235   int sep = ',';
236
237   /* Check options first for new-style file spec */
238   if (opts) for (uschar * s; s = string_nextinlist(&opts, &sep, NULL, 0); )
239     if (Ustrncmp(s, "file=", 5) == 0)
240       {
241       *fnamep = s+5;
242       return query;
243       }
244
245   /* If no filename from options, use old-tyle space-sep prefix on query */
246   if (*query == '/')
247     {
248     uschar * s = query;
249     while (*query && !isspace(*query)) query++;
250     *fnamep = string_copyn(s, query - s);
251     Uskip_whitespace(&query);
252     }
253   else
254     *fnamep = NULL;
255   return query;         /* remainder after file skipped */
256   }
257 if (!mac_islookup(search_type, lookup_querystyle))
258   {                                     /* single-key */
259   *fnamep = query;
260   return search;        /* modifiers important so use "keyquery" for them */
261   }
262 *fnamep = NULL;                         /* else query-style */
263 return query;
264 }
265
266
267
268 /*************************************************
269 *               Release cached resources         *
270 *************************************************/
271
272 /* When search_open is called it caches the "file" that it opens in
273 search_tree. The name of the tree node is a concatenation of the search type
274 with the file name. For query-style lookups, the file name is empty. Real files
275 are normally closed only when this tidyup routine is called, typically at the
276 end of sections of code where a number of lookups might occur. However, if too
277 many files are open simultaneously, some get closed beforehand. They can't be
278 removed from the tree. There is also a general tidyup function which is called
279 for the lookup driver, if it exists.
280
281 First, there is an internal, recursive subroutine.
282
283 Argument:    a pointer to a search_openfile tree node
284 Returns:     nothing
285 */
286
287 static void
288 tidyup_subtree(tree_node *t)
289 {
290 search_cache * c = (search_cache *)(t->data.ptr);
291 if (t->left)  tidyup_subtree(t->left);
292 if (t->right) tidyup_subtree(t->right);
293 if (c && c->handle && lookup_list[c->search_type]->close)
294   lookup_list[c->search_type]->close(c->handle);
295 }
296
297
298 /* The external entry point
299
300 Argument: none
301 Returns:  nothing
302 */
303
304 void
305 search_tidyup(void)
306 {
307 int old_pool = store_pool;
308
309 DEBUG(D_lookup) debug_printf_indent("search_tidyup called\n");
310
311 /* Close individually each cached open file. */
312
313 store_pool = POOL_SEARCH;
314 if (search_tree)
315   {
316   tidyup_subtree(search_tree);
317   search_tree = NULL;
318   }
319 open_top = open_bot = NULL;
320 open_filecount = 0;
321
322 /* Call the general tidyup entry for any drivers that have one. */
323
324 for (int i = 0; i < lookup_list_count; i++) if (lookup_list[i]->tidy)
325   (lookup_list[i]->tidy)();
326
327 if (search_reset_point) search_reset_point = store_reset(search_reset_point);
328 store_pool = old_pool;
329 }
330
331
332
333
334 /*************************************************
335 *             Open search database               *
336 *************************************************/
337
338 /* A mode, and lists of owners and groups, are passed over for checking in
339 the cases where the database is one or more files. Return NULL, with a message
340 pointed to by message, in cases of error.
341
342 For search types that use a file or files, check up on the mode after
343 opening. It is tempting to do a stat before opening the file, and use it as
344 an existence check. However, doing that opens a small security loophole in
345 that the status could be changed before the file is opened. Can't quite see
346 what problems this might lead to, but you can't be too careful where security
347 is concerned. Fstat() on an open file can normally be expected to succeed,
348 but there are some NFS states where it does not.
349
350 There are two styles of query: (1) in the "single-key+file" style, a single
351 key string and a file name are given, for example, for linear searches, DBM
352 files, or for NIS. (2) In the "query" style, no "filename" is given; instead
353 just a single query string is passed. This applies to multiple-key lookup
354 types such as NIS+.
355
356 Before opening, scan the tree of cached files to see if this file is already
357 open for the correct search type. If so, return the saved handle. If not, put
358 the handle in the tree for possible subsequent use. See search_tidyup above for
359 closing all the cached files.
360
361 A count of open databases which use real files is maintained, and if this
362 gets too large, we have to close a cached file. Its entry remains in the tree,
363 but is marked closed.
364
365 Arguments:
366   filename       the name of the file for single-key+file style lookups,
367                  NULL for query-style lookups
368   search_type    the type of search required
369   modemask       if a real single file is used, this specifies mode bits that
370                  must not be set; otherwise it is ignored
371   owners         if a real single file is used, this specifies the possible
372                  owners of the file; otherwise it is ignored
373   owngroups      if a real single file is used, this specifies the possible
374                  group owners of the file; otherwise it is ignored
375
376 Returns:         an identifying handle for the open database;
377                  this is the pointer to the tree block in the
378                  cache of open files; return NULL on open failure, with
379                  a message in search_error_message
380 */
381
382 void *
383 search_open(const uschar * filename, int search_type, int modemask,
384   uid_t * owners, gid_t * owngroups)
385 {
386 void *handle;
387 tree_node *t;
388 search_cache *c;
389 lookup_info *lk = lookup_list[search_type];
390 uschar keybuffer[256];
391 int old_pool = store_pool;
392
393 if (filename && is_tainted(filename))
394   {
395   log_write(0, LOG_MAIN|LOG_PANIC,
396     "Tainted filename for search: '%s'", filename);
397   return NULL;
398   }
399
400 /* Change to the search store pool and remember our reset point */
401
402 store_pool = POOL_SEARCH;
403 if (!search_reset_point) search_reset_point = store_mark();
404
405 DEBUG(D_lookup) debug_printf_indent("search_open: %s \"%s\"\n", lk->name,
406   filename ? filename : US"NULL");
407
408 /* See if we already have this open for this type of search, and if so,
409 pass back the tree block as the handle. The key for the tree node is the search
410 type plus '0' concatenated with the file name. There may be entries in the tree
411 with closed files if a lot of files have been opened. */
412
413 sprintf(CS keybuffer, "%c%.254s", search_type + '0',
414   filename ? filename : US"");
415
416 if ((t = tree_search(search_tree, keybuffer)))
417   {
418   if ((c = (search_cache *)t->data.ptr)->handle)
419     {
420     DEBUG(D_lookup) debug_printf_indent("  cached open\n");
421     store_pool = old_pool;
422     return t;
423     }
424   DEBUG(D_lookup) debug_printf_indent("  cached closed\n");
425   }
426
427 /* Otherwise, we need to open the file or database - each search type has its
428 own code, which is now split off into separately compiled modules. Before doing
429 this, if the search type is one that uses real files, check on the number that
430 we are holding open in the cache. If the limit is reached, close the least
431 recently used one. */
432
433 if (lk->type == lookup_absfile && open_filecount >= lookup_open_max)
434   if (!open_bot)
435     log_write(0, LOG_MAIN|LOG_PANIC, "too many lookups open, but can't find "
436       "one to close");
437   else
438     {
439     search_cache *c = (search_cache *)(open_bot->data.ptr);
440     DEBUG(D_lookup) debug_printf_indent("Too many lookup files open\n  closing %s\n",
441       open_bot->name);
442     if ((open_bot = c->up))
443       ((search_cache *)(open_bot->data.ptr))->down = NULL;
444     else
445       open_top = NULL;
446     ((lookup_list[c->search_type])->close)(c->handle);
447     c->handle = NULL;
448     open_filecount--;
449     }
450
451 /* If opening is successful, call the file-checking function if there is one,
452 and if all is still well, enter the open database into the tree. */
453
454 if (!(handle = (lk->open)(filename, &search_error_message)))
455   {
456   store_pool = old_pool;
457   return NULL;
458   }
459
460 if (  lk->check
461    && !lk->check(handle, filename, modemask, owners, owngroups,
462          &search_error_message))
463   {
464   lk->close(handle);
465   store_pool = old_pool;
466   return NULL;
467   }
468
469 /* If this is a search type that uses real files, keep count. */
470
471 if (lk->type == lookup_absfile) open_filecount++;
472
473 /* If we found a previously opened entry in the tree, re-use it; otherwise
474 insert a new entry. On re-use, leave any cached lookup data and the lookup
475 count alone. */
476
477 if (!t)
478   {
479   t = store_get(sizeof(tree_node) + Ustrlen(keybuffer), FALSE);
480   t->data.ptr = c = store_get(sizeof(search_cache), FALSE);
481   c->item_cache = NULL;
482   Ustrcpy(t->name, keybuffer);
483   tree_insertnode(&search_tree, t);
484   }
485 else c = t->data.ptr;
486
487 c->handle = handle;
488 c->search_type = search_type;
489 c->up = c->down = NULL;
490
491 store_pool = old_pool;
492 return t;
493 }
494
495
496
497
498
499 /*************************************************
500 *  Internal function: Find one item in database  *
501 *************************************************/
502
503 /* The answer is always put into dynamic store. The last lookup for each handle
504 is cached.
505
506 Arguments:
507   handle       the handle from search_open; points to tree node
508   filename     the filename that was handed to search_open, or
509                NULL for query-style searches
510   keystring    the keystring for single-key+file lookups, or
511                the querystring for query-style lookups
512   cache_rd     FALSE to avoid lookup in cache layer
513   opts         type-specific options
514
515 Returns:       a pointer to a dynamic string containing the answer,
516                or NULL if the query failed or was deferred; in the
517                latter case, search_find_defer is set TRUE; after an unusual
518                failure, there may be a message in search_error_message.
519 */
520
521 static uschar *
522 internal_search_find(void * handle, const uschar * filename, uschar * keystring,
523   BOOL cache_rd, const uschar * opts)
524 {
525 tree_node * t = (tree_node *)handle;
526 search_cache * c = (search_cache *)(t->data.ptr);
527 expiring_data * e = NULL;       /* compiler quietening */
528 uschar * data = NULL;
529 int search_type = t->name[0] - '0';
530 int old_pool = store_pool;
531
532 /* Lookups that return DEFER may not always set an error message. So that
533 the callers don't have to test for NULL, set an empty string. */
534
535 search_error_message = US"";
536 f.search_find_defer = FALSE;
537
538 DEBUG(D_lookup) debug_printf_indent("internal_search_find: file=\"%s\"\n  "
539   "type=%s key=\"%s\" opts=%s%s%s\n", filename,
540   lookup_list[search_type]->name, keystring,
541   opts ? "\"" : "", opts, opts ? "\"" : "");
542
543 /* Insurance. If the keystring is empty, just fail. */
544
545 if (keystring[0] == 0) return NULL;
546
547 /* Use the special store pool for search data */
548
549 store_pool = POOL_SEARCH;
550
551 /* Look up the data for the key, unless it is already in the cache for this
552 file. No need to check c->item_cache for NULL, tree_search will do so. Check
553 whether we want to use the cache entry last so that we can always replace it. */
554
555 if (  (t = tree_search(c->item_cache, keystring))
556    && (!(e = t->data.ptr)->expiry || e->expiry > time(NULL))
557    && (!opts && !e->opts  ||  opts && e->opts && Ustrcmp(opts, e->opts) == 0)
558    && cache_rd
559    )
560   { /* Data was in the cache already; set the pointer from the tree node */
561   data = e->data.ptr;
562   DEBUG(D_lookup) debug_printf_indent("cached data used for lookup of %s%s%s\n",
563     keystring,
564     filename ? US"\n  in " : US"", filename ? filename : US"");
565   }
566 else
567   {
568   uint do_cache = UINT_MAX;
569   int keylength = Ustrlen(keystring);
570
571   DEBUG(D_lookup)
572     {
573     if (t)
574       debug_printf_indent("cached data found but %s; ",
575         e->expiry && e->expiry <= time(NULL) ? "out-of-date"
576         : cache_rd ? "wrong opts" : "no_rd option set");
577     debug_printf_indent("%s lookup required for %s%s%s\n",
578       filename ? US"file" : US"database",
579       keystring,
580       filename ? US"\n  in " : US"", filename ? filename : US"");
581     }
582
583   /* Call the code for the different kinds of search. DEFER is handled
584   like FAIL, except that search_find_defer is set so the caller can
585   distinguish if necessary. */
586
587   if (lookup_list[search_type]->find(c->handle, filename, keystring, keylength,
588       &data, &search_error_message, &do_cache, opts) == DEFER)
589     f.search_find_defer = TRUE;
590
591   /* A record that has been found is now in data, which is either NULL
592   or points to a bit of dynamic store. Cache the result of the lookup if
593   caching is permitted. Lookups can disable caching, when they did something
594   that changes their data. The mysql and pgsql lookups do this when an
595   UPDATE/INSERT query was executed.  Lookups can also set a TTL for the
596   cache entry; the dnsdb lookup does.
597   Finally, the caller can request no caching by setting an option. */
598
599   else if (do_cache)
600     {
601     DEBUG(D_lookup) debug_printf_indent("%s cache entry\n",
602       t ? "replacing old" : "creating new");
603     if (!t)     /* No existing entry.  Create new one. */
604       {
605       int len = keylength + 1;
606       e = store_get(sizeof(expiring_data) + sizeof(tree_node) + len,
607                     is_tainted(keystring));
608       t = (tree_node *)(e+1);
609       memcpy(t->name, keystring, len);
610       t->data.ptr = e;
611       tree_insertnode(&c->item_cache, t);
612       }
613       /* Else previous, out-of-date cache entry.  Update with the */
614       /* new result and forget the old one */
615     e->expiry = do_cache == UINT_MAX ? 0 : time(NULL)+do_cache;
616     e->opts = opts ? string_copy(opts) : NULL;
617     e->data.ptr = data;
618     }
619
620 /* If caching was disabled, empty the cache tree. We just set the cache
621 pointer to NULL here, because we cannot release the store at this stage. */
622
623   else
624     {
625     DEBUG(D_lookup) debug_printf_indent("lookup forced cache cleanup\n");
626     c->item_cache = NULL;       /* forget all lookups on this connection */
627     }
628   }
629
630 DEBUG(D_lookup)
631   {
632   if (data)
633     debug_printf_indent("lookup yielded: %s\n", data);
634   else if (f.search_find_defer)
635     debug_printf_indent("lookup deferred: %s\n", search_error_message);
636   else debug_printf_indent("lookup failed\n");
637   }
638
639 /* Return it in new dynamic store in the regular pool */
640
641 store_pool = old_pool;
642 return data ? string_copy(data) : NULL;
643 }
644
645
646
647
648 /*************************************************
649 * Find one item in database, possibly wildcarded *
650 *************************************************/
651
652 /* This function calls the internal function above; once only if there
653 is no partial matching, but repeatedly when partial matching is requested.
654
655 Arguments:
656   handle         the handle from search_open
657   filename       the filename that was handed to search_open, or
658                    NULL for query-style searches
659   keystring      the keystring for single-key+file lookups, or
660                    the querystring for query-style lookups
661   partial        -1 means no partial matching;
662                    otherwise it's the minimum number of components;
663   affix          the affix string for partial matching
664   affixlen       the length of the affix string
665   starflags      SEARCH_STAR and SEARCH_STARAT flags
666   expand_setup   pointer to offset for setting up expansion strings;
667                  don't do any if < 0
668   opts           type-specific options
669
670 Returns:         a pointer to a dynamic string containing the answer,
671                  or NULL if the query failed or was deferred; in the
672                  latter case, search_find_defer is set TRUE
673 */
674
675 uschar *
676 search_find(void * handle, const uschar * filename, uschar * keystring,
677   int partial, const uschar * affix, int affixlen, int starflags,
678   int * expand_setup, const uschar * opts)
679 {
680 tree_node * t = (tree_node *)handle;
681 BOOL set_null_wild = FALSE, cache_rd = TRUE, ret_key = FALSE;
682 uschar * yield;
683
684 DEBUG(D_lookup)
685   {
686   if (partial < 0) affixlen = 99;   /* So that "NULL" prints */
687   debug_printf_indent("search_find: file=\"%s\"\n  key=\"%s\" "
688     "partial=%d affix=%.*s starflags=%x opts=%s%s%s\n",
689     filename ? filename : US"NULL",
690     keystring, partial, affixlen, affix, starflags,
691     opts ? "\"" : "", opts, opts ? "\"" : "");
692
693   }
694
695 /* Parse global lookup options. Also, create a new options list with
696 the global options dropped so that the cache-modifiers are not
697 used in the cache key. */
698
699 if (opts)
700   {
701   int sep = ',';
702   gstring * g = NULL;
703
704   for (uschar * ele; ele = string_nextinlist(&opts, &sep, NULL, 0); )
705     if (Ustrcmp(ele, "ret=key") == 0) ret_key = TRUE;
706     else if (Ustrcmp(ele, "cache=no_rd") == 0) cache_rd = FALSE;
707     else g = string_append_listele(g, ',', ele);
708
709   opts = string_from_gstring(g);
710   }
711
712 /* Arrange to put this database at the top of the LRU chain if it is a type
713 that opens real files. */
714
715 if (  open_top != (tree_node *)handle 
716    && lookup_list[t->name[0]-'0']->type == lookup_absfile)
717   {
718   search_cache *c = (search_cache *)(t->data.ptr);
719   tree_node *up = c->up;
720   tree_node *down = c->down;
721
722   /* Cut it out of the list. A newly opened file will a NULL up pointer.
723   Otherwise there will be a non-NULL up pointer, since we checked above that
724   this block isn't already at the top of the list. */
725
726   if (up)
727     {
728     ((search_cache *)(up->data.ptr))->down = down;
729     if (down)
730       ((search_cache *)(down->data.ptr))->up = up;
731     else
732       open_bot = up;
733     }
734
735   /* Now put it at the head of the list. */
736
737   c->up = NULL;
738   c->down = open_top;
739   if (!open_top) open_bot = t;
740   else ((search_cache *)(open_top->data.ptr))->up = t;
741   open_top = t;
742   }
743
744 DEBUG(D_lookup)
745   {
746   debug_printf_indent("LRU list:\n");
747   for (tree_node *t = open_top; t; )
748     {
749     search_cache *c = (search_cache *)(t->data.ptr);
750     debug_printf_indent("  %s\n", t->name);
751     if (t == open_bot) debug_printf_indent("  End\n");
752     t = c->down;
753     }
754   }
755
756 /* First of all, try to match the key string verbatim. If matched a complete
757 entry but could have been partial, flag to set up variables. */
758
759 yield = internal_search_find(handle, filename, keystring, cache_rd, opts);
760 if (f.search_find_defer) return NULL;
761
762 if (yield) { if (partial >= 0) set_null_wild = TRUE; }
763
764 /* Not matched a complete entry; handle partial lookups, but only if the full
765 search didn't defer. Don't use string_sprintf() to construct the initial key,
766 just in case the original key is too long for the string_sprintf() buffer (it
767 *has* happened!). The case of a zero-length affix has to be treated specially.
768 */
769
770 else if (partial >= 0)
771   {
772   int len = Ustrlen(keystring);
773   uschar *keystring2;
774
775   /* Try with the affix on the front, except for a zero-length affix */
776
777   if (affixlen == 0) keystring2 = keystring; else
778     {
779     keystring2 = store_get(len + affixlen + 1,
780                         is_tainted(keystring) || is_tainted(affix));
781     Ustrncpy(keystring2, affix, affixlen);
782     Ustrcpy(keystring2 + affixlen, keystring);
783     DEBUG(D_lookup) debug_printf_indent("trying partial match %s\n", keystring2);
784     yield = internal_search_find(handle, filename, keystring2, cache_rd, opts);
785     if (f.search_find_defer) return NULL;
786     }
787
788   /* The key in its entirety did not match a wild entry; try chopping off
789   leading components. */
790
791   if (!yield)
792     {
793     int dotcount = 0;
794     uschar *keystring3 = keystring2 + affixlen;
795     uschar *s = keystring3;
796     while (*s != 0) if (*s++ == '.') dotcount++;
797
798     while (dotcount-- >= partial)
799       {
800       while (*keystring3 != 0 && *keystring3 != '.') keystring3++;
801
802       /* If we get right to the end of the string (which will be the last time
803       through this loop), we've failed if the affix is null. Otherwise do one
804       last lookup for the affix itself, but if it is longer than 1 character,
805       remove the last character if it is ".". */
806
807       if (*keystring3 == 0)
808         {
809         if (affixlen < 1) break;
810         if (affixlen > 1 && affix[affixlen-1] == '.') affixlen--;
811         Ustrncpy(keystring2, affix, affixlen);
812         keystring2[affixlen] = 0;
813         keystring3 = keystring2;
814         }
815       else
816         {
817         keystring3 -= affixlen - 1;
818         if (affixlen > 0) Ustrncpy(keystring3, affix, affixlen);
819         }
820
821       DEBUG(D_lookup) debug_printf_indent("trying partial match %s\n", keystring3);
822       yield = internal_search_find(handle, filename, keystring3,
823                 cache_rd, opts);
824       if (f.search_find_defer) return NULL;
825       if (yield)
826         {
827         /* First variable is the wild part; second is the fixed part. Take care
828         to get it right when keystring3 is just "*". */
829
830         if (expand_setup && *expand_setup >= 0)
831           {
832           int fixedlength = Ustrlen(keystring3) - affixlen;
833           int wildlength = Ustrlen(keystring) - fixedlength - 1;
834           *expand_setup += 1;
835           expand_nstring[*expand_setup] = keystring;
836           expand_nlength[*expand_setup] = wildlength;
837           *expand_setup += 1;
838           expand_nstring[*expand_setup] = keystring + wildlength + 1;
839           expand_nlength[*expand_setup] = (fixedlength < 0)? 0 : fixedlength;
840           }
841         break;
842         }
843       keystring3 += affixlen;
844       }
845     }
846
847   else set_null_wild = TRUE; /* Matched a wild entry without any wild part */
848   }
849
850 /* If nothing has been matched, but the option to look for "*@" is set, try
851 replacing everything to the left of @ by *. After a match, the wild part
852 is set to the string to the left of the @. */
853
854 if (!yield  &&  starflags & SEARCH_STARAT)
855   {
856   uschar *atat = Ustrrchr(keystring, '@');
857   if (atat != NULL && atat > keystring)
858     {
859     int savechar;
860     savechar = *(--atat);
861     *atat = '*';
862
863     DEBUG(D_lookup) debug_printf_indent("trying default match %s\n", atat);
864     yield = internal_search_find(handle, filename, atat, cache_rd, opts);
865     *atat = savechar;
866     if (f.search_find_defer) return NULL;
867
868     if (yield && expand_setup && *expand_setup >= 0)
869       {
870       *expand_setup += 1;
871       expand_nstring[*expand_setup] = keystring;
872       expand_nlength[*expand_setup] = atat - keystring + 1;
873       *expand_setup += 1;
874       expand_nstring[*expand_setup] = keystring;
875       expand_nlength[*expand_setup] = 0;
876       }
877     }
878   }
879
880 /* If we still haven't matched anything, and the option to look for "*" is set,
881 try that. If we do match, the first variable (the wild part) is the whole key,
882 and the second is empty. */
883
884 if (!yield  &&  starflags & (SEARCH_STAR|SEARCH_STARAT))
885   {
886   DEBUG(D_lookup) debug_printf_indent("trying to match *\n");
887   yield = internal_search_find(handle, filename, US"*", cache_rd, opts);
888   if (yield && expand_setup && *expand_setup >= 0)
889     {
890     *expand_setup += 1;
891     expand_nstring[*expand_setup] = keystring;
892     expand_nlength[*expand_setup] = Ustrlen(keystring);
893     *expand_setup += 1;
894     expand_nstring[*expand_setup] = keystring;
895     expand_nlength[*expand_setup] = 0;
896     }
897   }
898
899 /* If this was a potentially partial lookup, and we matched either a
900 complete non-wild domain entry, or we matched a wild-carded entry without
901 chopping off any of the domain components, set up the expansion variables
902 (if required) so that the first one is empty, and the second one is the
903 fixed part of the domain. The set_null_wild flag is set only when yield is not
904 NULL. */
905
906 if (set_null_wild && expand_setup && *expand_setup >= 0)
907   {
908   *expand_setup += 1;
909   expand_nstring[*expand_setup] = keystring;
910   expand_nlength[*expand_setup] = 0;
911   *expand_setup += 1;
912   expand_nstring[*expand_setup] = keystring;
913   expand_nlength[*expand_setup] = Ustrlen(keystring);
914   }
915
916 /* If we have a result, check the options to see if the key was wanted rather
917 than the result.  Return a de-tainted version of the key on the grounds that
918 it have been validated by the lookup. */
919
920 if (yield && ret_key)
921   yield = string_copy_taint(keystring, FALSE);
922
923 return yield;
924 }
925
926 /* End of search.c */