35a9464470e983a7e71de5a4e87c4a63cc45b0ae
[exim.git] / src / src / lookups / dnsdb.c
1 /*************************************************
2 *     Exim - an Internet mail transport agent    *
3 *************************************************/
4
5 /* Copyright (c) The Exim Maintainers 2020 - 2022 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
9
10 #include "../exim.h"
11 #include "lf_functions.h"
12
13
14
15 /* Ancient systems (e.g. SunOS4) don't appear to have T_TXT defined in their
16 header files. */
17
18 #ifndef T_TXT
19 # define T_TXT 16
20 #endif
21
22 /* Many systems do not have T_SPF. */
23 #ifndef T_SPF
24 # define T_SPF 99
25 #endif
26
27 /* New TLSA record for DANE */
28 #ifndef T_TLSA
29 # define T_TLSA 52
30 #endif
31
32 /* Table of recognized DNS record types and their integer values. */
33
34 static const char *type_names[] = {
35   "a",
36 #if HAVE_IPV6
37   "a+",
38   "aaaa",
39 #endif
40   "cname",
41   "csa",
42   "mx",
43   "mxh",
44   "ns",
45   "ptr",
46   "soa",
47   "spf",
48   "srv",
49   "tlsa",
50   "txt",
51   "zns"
52 };
53
54 static int type_values[] = {
55   T_A,
56 #if HAVE_IPV6
57   T_ADDRESSES,     /* Private type for AAAA + A */
58   T_AAAA,
59 #endif
60   T_CNAME,
61   T_CSA,     /* Private type for "Client SMTP Authorization". */
62   T_MX,
63   T_MXH,     /* Private type for "MX hostnames" */
64   T_NS,
65   T_PTR,
66   T_SOA,
67   T_SPF,
68   T_SRV,
69   T_TLSA,
70   T_TXT,
71   T_ZNS      /* Private type for "zone nameservers" */
72 };
73
74
75 /*************************************************
76 *              Open entry point                  *
77 *************************************************/
78
79 /* See local README for interface description. */
80
81 static void *
82 dnsdb_open(const uschar * filename, uschar **errmsg)
83 {
84 return (void *)(-1);   /* Any non-0 value */
85 }
86
87
88
89 /*************************************************
90 *           Find entry point for dnsdb           *
91 *************************************************/
92
93 /* See local README for interface description. The query in the "keystring" may
94 consist of a number of parts.
95
96 (a) If the first significant character is '>' then the next character is the
97 separator character that is used when multiple records are found. The default
98 separator is newline.
99
100 (b) If the next character is ',' then the next character is the separator
101 character used for multiple items of text in "TXT" records. Alternatively,
102 if the next character is ';' then these multiple items are concatenated with
103 no separator. With neither of these options specified, only the first item
104 is output.  Similarly for "SPF" records, but the default for joining multiple
105 items in one SPF record is the empty string, for direct concatenation.
106
107 (c) Options, all comma-terminated, in any order.  Any unrecognised option
108 terminates option processing.  Recognised options are:
109
110 - 'defer_FOO':  set the defer behaviour to FOO.  The possible behaviours are:
111 'strict', where any defer causes the whole lookup to defer; 'lax', where a defer
112 causes the whole lookup to defer only if none of the DNS queries succeeds; and
113 'never', where all defers are as if the lookup failed. The default is 'lax'.
114
115 - 'dnssec_FOO', with 'strict', 'lax' (default), and 'never'.  The meanings are
116 require, try and don't-try dnssec respectively.
117
118 - 'retrans_VAL', set the timeout value.  VAL is an Exim time specification
119 (eg "5s").  The default is set by the main configuration option 'dns_retrans'.
120
121 - 'retry_VAL', set the retry count on timeouts.  VAL is an integer.  The
122 default is set by the main configuration option "dns_retry".
123
124 (d) If the next sequence of characters is a sequence of letters and digits
125 followed by '=', it is interpreted as the name of the DNS record type. The
126 default is "TXT".
127
128 (e) Then there follows list of domain names. This is a generalized Exim list,
129 which may start with '<' in order to set a specific separator. The default
130 separator, as always, is colon. */
131
132 static int
133 dnsdb_find(void * handle, const uschar * filename, const uschar * keystring,
134  int length, uschar ** result, uschar ** errmsg, uint * do_cache,
135  const uschar * opts)
136 {
137 int rc;
138 int sep = 0;
139 int defer_mode = PASS, dnssec_mode = PASS;
140 int save_retrans = dns_retrans, save_retry =   dns_retry;
141 int type;
142 int failrc = FAIL;
143 const uschar * outsep = CUS"\n", * outsep2 = NULL;
144 uschar * equals, * domain, * found;
145
146 dns_answer * dnsa = store_get_dns_answer();
147 dns_scan dnss;
148
149 /* Because we're working in the search pool, we try to reclaim as much
150 store as possible later, so we preallocate the result here */
151
152 gstring * yield = string_get(256);
153
154 /* If the string starts with '>' we change the output separator.
155 If it's followed by ';' or ',' we set the TXT output separator. */
156
157 while (isspace(*keystring)) keystring++;
158 if (*keystring == '>')
159   {
160   outsep = keystring + 1;
161   keystring += 2;
162   if (*keystring == ',')
163     {
164     outsep2 = keystring + 1;
165     keystring += 2;
166     }
167   else if (*keystring == ';')
168     {
169     outsep2 = US"";
170     keystring++;
171     }
172   while (isspace(*keystring)) keystring++;
173   }
174
175 /* Check for a modifier keyword. */
176
177 for (;;)
178   {
179   if (strncmpic(keystring, US"defer_", 6) == 0)
180     {
181     keystring += 6;
182     if (strncmpic(keystring, US"strict", 6) == 0)
183       { defer_mode = DEFER; keystring += 6; }
184     else if (strncmpic(keystring, US"lax", 3) == 0)
185       { defer_mode = PASS; keystring += 3; }
186     else if (strncmpic(keystring, US"never", 5) == 0)
187       { defer_mode = OK; keystring += 5; }
188     else
189       {
190       *errmsg = US"unsupported dnsdb defer behaviour";
191       rc = DEFER;
192       goto out;
193       }
194     }
195   else if (strncmpic(keystring, US"dnssec_", 7) == 0)
196     {
197     keystring += 7;
198     if (strncmpic(keystring, US"strict", 6) == 0)
199       { dnssec_mode = DEFER; keystring += 6; }
200     else if (strncmpic(keystring, US"lax", 3) == 0)
201       { dnssec_mode = PASS; keystring += 3; }
202     else if (strncmpic(keystring, US"never", 5) == 0)
203       { dnssec_mode = OK; keystring += 5; }
204     else
205       {
206       *errmsg = US"unsupported dnsdb dnssec behaviour";
207       rc = DEFER;
208       goto out;
209       }
210     }
211   else if (strncmpic(keystring, US"retrans_", 8) == 0)
212     {
213     int timeout_sec;
214     if ((timeout_sec = readconf_readtime(keystring += 8, ',', FALSE)) <= 0)
215       {
216       *errmsg = US"unsupported dnsdb timeout value";
217       rc = DEFER;
218       goto out;
219       }
220     dns_retrans = timeout_sec;
221     while (*keystring != ',') keystring++;
222     }
223   else if (strncmpic(keystring, US"retry_", 6) == 0)
224     {
225     int retries;
226     if ((retries = (int)strtol(CCS keystring + 6, CSS &keystring, 0)) < 0)
227       {
228       *errmsg = US"unsupported dnsdb retry count";
229       rc = DEFER;
230       goto out;
231       }
232     dns_retry = retries;
233     }
234   else
235     break;
236
237   while (isspace(*keystring)) keystring++;
238   if (*keystring++ != ',')
239     {
240     *errmsg = US"dnsdb modifier syntax error";
241     rc = DEFER;
242     goto out;
243     }
244   while (isspace(*keystring)) keystring++;
245   }
246
247 /* Figure out the "type" value if it is not T_TXT.
248 If the keystring contains an = this must be preceded by a valid type name. */
249
250 type = T_TXT;
251 if ((equals = Ustrchr(keystring, '=')) != NULL)
252   {
253   int i, len;
254   uschar *tend = equals;
255
256   while (tend > keystring && isspace(tend[-1])) tend--;
257   len = tend - keystring;
258
259   for (i = 0; i < nelem(type_names); i++)
260     if (len == Ustrlen(type_names[i]) &&
261         strncmpic(keystring, US type_names[i], len) == 0)
262       {
263       type = type_values[i];
264       break;
265       }
266
267   if (i >= nelem(type_names))
268     {
269     *errmsg = US"unsupported DNS record type";
270     rc = DEFER;
271     goto out;
272     }
273
274   keystring = equals + 1;
275   while (isspace(*keystring)) keystring++;
276   }
277
278 /* Initialize the resolver in case this is the first time it has been used. */
279
280 dns_init(FALSE, FALSE, dnssec_mode != OK);
281
282 /* The remainder of the string must be a list of domains. As long as the lookup
283 for at least one of them succeeds, we return success. Failure means that none
284 of them were found.
285
286 The original implementation did not support a list of domains. Adding the list
287 feature is compatible, except in one case: when PTR records are being looked up
288 for a single IPv6 address. Fortunately, we can hack in a compatibility feature
289 here: If the type is PTR and no list separator is specified, and the entire
290 remaining string is valid as an IP address, set an impossible separator so that
291 it is treated as one item. */
292
293 if (type == T_PTR && keystring[0] != '<' &&
294     string_is_ip_address(keystring, NULL) != 0)
295   sep = -1;
296
297 /* SPF strings should be concatenated without a separator, thus make
298 it the default if not defined (see RFC 4408 section 3.1.3).
299 Multiple SPF records are forbidden (section 3.1.2) but are currently
300 not handled specially, thus they are concatenated with \n by default.
301 MX priority and value are space-separated by default.
302 SRV and TLSA record parts are space-separated by default. */
303
304 if (!outsep2) switch(type)
305   {
306   case T_SPF:                         outsep2 = US"";  break;
307   case T_SRV: case T_MX: case T_TLSA: outsep2 = US" "; break;
308   }
309
310 /* Now scan the list and do a lookup for each item */
311
312 while ((domain = string_nextinlist(&keystring, &sep, NULL, 0)))
313   {
314   int searchtype = type == T_CSA ? T_SRV :         /* record type we want */
315                    type == T_MXH ? T_MX :
316                    type == T_ZNS ? T_NS : type;
317
318   /* If the type is PTR or CSA, we have to construct the relevant magic lookup
319   key if the original is an IP address (some experimental protocols are using
320   PTR records for different purposes where the key string is a host name, and
321   Exim's extended CSA can be keyed by domains or IP addresses). This code for
322   doing the reversal is now in a separate function. */
323
324   if ((type == T_PTR || type == T_CSA) &&
325       string_is_ip_address(domain, NULL) != 0)
326     domain = dns_build_reverse(domain);
327
328   do
329     {
330     DEBUG(D_lookup) debug_printf_indent("dnsdb key: %s\n", domain);
331
332     /* Do the lookup and sort out the result. There are four special types that
333     are handled specially: T_CSA, T_ZNS, T_ADDRESSES and T_MXH.
334     The first two are handled in a special lookup function so that the facility
335     could be used from other parts of the Exim code. T_ADDRESSES is handled by looping
336     over the types of A lookup.  T_MXH affects only what happens later on in
337     this function, but for tidiness it is handled by the "special". If the
338     lookup fails, continue with the next domain. In the case of DEFER, adjust
339     the final "nothing found" result, but carry on to the next domain. */
340
341     found = domain;
342 #if HAVE_IPV6
343     if (type == T_ADDRESSES)            /* NB cannot happen unless HAVE_IPV6 */
344       {
345       if (searchtype == T_ADDRESSES) searchtype = T_AAAA;
346       else if (searchtype == T_AAAA) searchtype = T_A;
347       rc = dns_special_lookup(dnsa, domain, searchtype, CUSS &found);
348       }
349     else
350 #endif
351       rc = dns_special_lookup(dnsa, domain, type, CUSS &found);
352
353     lookup_dnssec_authenticated = dnssec_mode==OK ? NULL
354       : dns_is_secure(dnsa) ? US"yes" : US"no";
355
356     if (rc == DNS_NOMATCH || rc == DNS_NODATA) continue;
357     if (  rc != DNS_SUCCEED
358        || (dnssec_mode == DEFER && !dns_is_secure(dnsa))
359        )
360       {
361       if (defer_mode == DEFER)
362         {
363         dns_retrans = save_retrans;
364         dns_retry = save_retry;
365         dns_init(FALSE, FALSE, FALSE);                  /* clr dnssec bit */
366         rc = DEFER;                                     /* always defer */
367         goto out;
368         }
369       if (defer_mode == PASS) failrc = DEFER;         /* defer only if all do */
370       continue;                                       /* treat defer as fail */
371       }
372
373
374     /* Search the returned records */
375
376     for (dns_record * rr = dns_next_rr(dnsa, &dnss, RESET_ANSWERS); rr;
377          rr = dns_next_rr(dnsa, &dnss, RESET_NEXT)) if (rr->type == searchtype)
378       {
379       if (*do_cache > rr->ttl)
380         *do_cache = rr->ttl;
381
382       if (type == T_A || type == T_AAAA || type == T_ADDRESSES)
383         {
384         for (dns_address * da = dns_address_from_rr(dnsa, rr); da; da = da->next)
385           yield = string_append_listele(yield, *outsep, da->address);
386         continue;
387         }
388
389       /* Other kinds of record just have one piece of data each, but there may be
390       several of them, of course. */
391
392       if (yield->ptr) yield = string_catn(yield, outsep, 1);
393
394       if (type == T_TXT || type == T_SPF)
395         {
396         if (!outsep2)                   /* output only the first item of data */
397           {
398           uschar n = (rr->data)[0];
399           /* size byte + data bytes must not excced the RRs length */
400           if (n + 1 <= rr->size)
401             yield = string_catn(yield, US (rr->data+1), n);
402           }
403         else
404           for (unsigned data_offset = 0; data_offset < rr->size; )
405             {
406             uschar chunk_len = (rr->data)[data_offset];
407             int remain = rr->size - data_offset;
408
409             /* Apparently there are resolvers that do not check RRs before passing
410             them on, and glibc fails to do so.  So every application must...
411             Check for chunk len exceeding RR */
412
413             if (chunk_len > remain)
414               chunk_len = remain;
415
416             if (*outsep2  && data_offset != 0)
417               yield = string_catn(yield, outsep2, 1);
418             yield = string_catn(yield, US ((rr->data) + ++data_offset), --chunk_len);
419             data_offset += chunk_len;
420             }
421         }
422       else if (type == T_TLSA)
423         if (rr->size < 3)
424           continue;
425         else
426           {
427           uint8_t usage, selector, matching_type;
428           uint16_t payload_length;
429           uschar s[MAX_TLSA_EXPANDED_SIZE];
430           uschar * sp = s;
431           uschar * p = US rr->data;
432
433           usage = *p++;
434           selector = *p++;
435           matching_type = *p++;
436           /* What's left after removing the first 3 bytes above */
437           payload_length = rr->size - 3;
438           sp += sprintf(CS s, "%d%c%d%c%d%c", usage, *outsep2,
439                   selector, *outsep2, matching_type, *outsep2);
440           /* Now append the cert/identifier, one hex char at a time */
441           while (payload_length-- > 0 && sp-s < (MAX_TLSA_EXPANDED_SIZE - 4))
442             sp += sprintf(CS sp, "%02x", *p++);
443
444           yield = string_cat(yield, s);
445           }
446       else   /* T_CNAME, T_CSA, T_MX, T_MXH, T_NS, T_PTR, T_SOA, T_SRV */
447         {
448         int priority, weight, port;
449         uschar s[264];
450         uschar * p = US rr->data;
451
452         switch (type)
453           {
454           case T_MXH:
455             if (rr->size < sizeof(u_int16_t)) continue;
456             /* mxh ignores the priority number and includes only the hostnames */
457             GETSHORT(priority, p);
458             break;
459
460           case T_MX:
461             if (rr->size < sizeof(u_int16_t)) continue;
462             GETSHORT(priority, p);
463             sprintf(CS s, "%d%c", priority, *outsep2);
464             yield = string_cat(yield, s);
465             break;
466
467           case T_SRV:
468             if (rr->size < 3*sizeof(u_int16_t)) continue;
469             GETSHORT(priority, p);
470             GETSHORT(weight, p);
471             GETSHORT(port, p);
472             sprintf(CS s, "%d%c%d%c%d%c", priority, *outsep2,
473                               weight, *outsep2, port, *outsep2);
474             yield = string_cat(yield, s);
475             break;
476
477           case T_CSA:
478             if (rr->size < 3*sizeof(u_int16_t)) continue;
479             /* See acl_verify_csa() for more comments about CSA. */
480             GETSHORT(priority, p);
481             GETSHORT(weight, p);
482             GETSHORT(port, p);
483
484             if (priority != 1) continue;      /* CSA version must be 1 */
485
486             /* If the CSA record we found is not the one we asked for, analyse
487             the subdomain assertions in the port field, else analyse the direct
488             authorization status in the weight field. */
489
490             if (Ustrcmp(found, domain) != 0)
491               {
492               if (port & 1) *s = 'X';         /* explicit authorization required */
493               else *s = '?';                  /* no subdomain assertions here */
494               }
495             else
496               {
497               if (weight < 2) *s = 'N';       /* not authorized */
498               else if (weight == 2) *s = 'Y'; /* authorized */
499               else if (weight == 3) *s = '?'; /* unauthorizable */
500               else continue;                  /* invalid */
501               }
502
503             s[1] = ' ';
504             yield = string_catn(yield, s, 2);
505             break;
506
507           default:
508             break;
509           }
510
511         /* GETSHORT() has advanced the pointer to the target domain. */
512
513         rc = dn_expand(dnsa->answer, dnsa->answer + dnsa->answerlen, p,
514           (DN_EXPAND_ARG4_TYPE)s, sizeof(s));
515
516         /* If an overlong response was received, the data will have been
517         truncated and dn_expand may fail. */
518
519         if (rc < 0)
520           {
521           log_write(0, LOG_MAIN, "host name alias list truncated: type=%s "
522             "domain=%s", dns_text_type(type), domain);
523           break;
524           }
525         else yield = string_cat(yield, s);
526
527         if (type == T_SOA && outsep2 != NULL)
528           {
529           unsigned long serial = 0, refresh = 0, retry = 0, expire = 0, minimum = 0;
530
531           p += rc;
532           yield = string_catn(yield, outsep2, 1);
533
534           rc = dn_expand(dnsa->answer, dnsa->answer + dnsa->answerlen, p,
535             (DN_EXPAND_ARG4_TYPE)s, sizeof(s));
536           if (rc < 0)
537             {
538             log_write(0, LOG_MAIN, "responsible-mailbox truncated: type=%s "
539               "domain=%s", dns_text_type(type), domain);
540             break;
541             }
542           else yield = string_cat(yield, s);
543
544           p += rc;
545           if (rr->size >= p - rr->data - 5*sizeof(u_int32_t))
546             {
547             GETLONG(serial, p); GETLONG(refresh, p);
548             GETLONG(retry,  p); GETLONG(expire,  p); GETLONG(minimum, p);
549             }
550           sprintf(CS s, "%c%lu%c%lu%c%lu%c%lu%c%lu",
551             *outsep2, serial, *outsep2, refresh,
552             *outsep2, retry,  *outsep2, expire,  *outsep2, minimum);
553           yield = string_cat(yield, s);
554           }
555         }
556       }    /* Loop for list of returned records */
557
558            /* Loop for set of A-lookup types */
559     } while (type == T_ADDRESSES && searchtype != T_A);
560
561   }        /* Loop for list of domains */
562
563 /* Reclaim unused memory */
564
565 gstring_release_unused(yield);
566
567 /* If yield NULL we have not found anything. Otherwise, insert the terminating
568 zero and return the result. */
569
570 dns_retrans = save_retrans;
571 dns_retry = save_retry;
572 dns_init(FALSE, FALSE, FALSE);  /* clear the dnssec bit for getaddrbyname */
573
574 if (!yield || !yield->ptr)
575   rc = failrc;
576 else
577   {
578   *result = string_from_gstring(yield);
579   rc = OK;
580   }
581
582 out:
583
584 store_free_dns_answer(dnsa);
585 return rc;
586 }
587
588
589
590 /*************************************************
591 *         Version reporting entry point          *
592 *************************************************/
593
594 /* See local README for interface description. */
595
596 #include "../version.h"
597
598 gstring *
599 dnsdb_version_report(gstring * g)
600 {
601 #ifdef DYNLOOKUP
602 g = string_fmt_append(g, "Library version: DNSDB: Exim version %s\n", EXIM_VERSION_STR);
603 #endif
604 return g;
605 }
606
607
608 static lookup_info _lookup_info = {
609   .name = US"dnsdb",                    /* lookup name */
610   .type = lookup_querystyle,            /* query style */
611   .open = dnsdb_open,                   /* open function */
612   .check = NULL,                        /* check function */
613   .find = dnsdb_find,                   /* find function */
614   .close = NULL,                        /* no close function */
615   .tidy = NULL,                         /* no tidy function */
616   .quote = NULL,                        /* no quoting function */
617   .version_report = dnsdb_version_report           /* version reporting */
618 };
619
620 #ifdef DYNLOOKUP
621 #define dnsdb_lookup_module_info _lookup_module_info
622 #endif
623
624 static lookup_info *_lookup_list[] = { &_lookup_info };
625 lookup_module_info dnsdb_lookup_module_info = { LOOKUP_MODULE_INFO_MAGIC, _lookup_list, 1 };
626
627 /* vi: aw ai sw=2
628 */
629 /* End of lookups/dnsdb.c */