1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2016 */
6 /* See the file NOTICE for conditions of use and distribution. */
13 /* This module contains tables that define the lookup methods and drivers
14 that are actually included in the binary. Its contents are controlled by
15 various macros in config.h that ultimately come from Local/Makefile. They are
16 all described in src/EDITME. */
19 lookup_info **lookup_list;
20 int lookup_list_count = 0;
22 static int lookup_list_init_done = 0;
24 /* Table of information about all possible authentication mechamisms. All
25 entries are always present if any mechanism is declared, but the functions are
26 set to NULL for those that are not compiled into the binary. */
29 #include "auths/cram_md5.h"
32 #ifdef AUTH_CYRUS_SASL
33 #include "auths/cyrus_sasl.h"
37 #include "auths/dovecot.h"
41 #include "auths/gsasl_exim.h"
44 #ifdef AUTH_HEIMDAL_GSSAPI
45 #include "auths/heimdal_gssapi.h"
49 #include "auths/plaintext.h"
53 #include "auths/spa.h"
57 #include "auths/tls.h"
60 auth_info auths_available[] = {
62 /* Checking by an expansion condition on plain text */
66 US"cram_md5", /* lookup name */
67 auth_cram_md5_options,
68 &auth_cram_md5_options_count,
69 &auth_cram_md5_option_defaults,
70 sizeof(auth_cram_md5_options_block),
71 auth_cram_md5_init, /* init function */
72 auth_cram_md5_server, /* server function */
73 auth_cram_md5_client, /* client function */
74 NULL /* diagnostic function */
78 #ifdef AUTH_CYRUS_SASL
80 US"cyrus_sasl", /* lookup name */
81 auth_cyrus_sasl_options,
82 &auth_cyrus_sasl_options_count,
83 &auth_cyrus_sasl_option_defaults,
84 sizeof(auth_cyrus_sasl_options_block),
85 auth_cyrus_sasl_init, /* init function */
86 auth_cyrus_sasl_server, /* server function */
87 NULL, /* client function */
88 auth_cyrus_sasl_version_report /* diagnostic function */
94 US"dovecot", /* lookup name */
96 &auth_dovecot_options_count,
97 &auth_dovecot_option_defaults,
98 sizeof(auth_dovecot_options_block),
99 auth_dovecot_init, /* init function */
100 auth_dovecot_server, /* server function */
101 NULL, /* client function */
102 NULL /* diagnostic function */
108 US"gsasl", /* lookup name */
110 &auth_gsasl_options_count,
111 &auth_gsasl_option_defaults,
112 sizeof(auth_gsasl_options_block),
113 auth_gsasl_init, /* init function */
114 auth_gsasl_server, /* server function */
115 NULL, /* client function */
116 auth_gsasl_version_report /* diagnostic function */
120 #ifdef AUTH_HEIMDAL_GSSAPI
122 US"heimdal_gssapi", /* lookup name */
123 auth_heimdal_gssapi_options,
124 &auth_heimdal_gssapi_options_count,
125 &auth_heimdal_gssapi_option_defaults,
126 sizeof(auth_heimdal_gssapi_options_block),
127 auth_heimdal_gssapi_init, /* init function */
128 auth_heimdal_gssapi_server, /* server function */
129 NULL, /* client function */
130 auth_heimdal_gssapi_version_report /* diagnostic function */
134 #ifdef AUTH_PLAINTEXT
136 US"plaintext", /* lookup name */
137 auth_plaintext_options,
138 &auth_plaintext_options_count,
139 &auth_plaintext_option_defaults,
140 sizeof(auth_plaintext_options_block),
141 auth_plaintext_init, /* init function */
142 auth_plaintext_server, /* server function */
143 auth_plaintext_client, /* client function */
144 NULL /* diagnostic function */
150 US"spa", /* lookup name */
152 &auth_spa_options_count,
153 &auth_spa_option_defaults,
154 sizeof(auth_spa_options_block),
155 auth_spa_init, /* init function */
156 auth_spa_server, /* server function */
157 auth_spa_client, /* client function */
158 NULL /* diagnostic function */
164 US"tls", /* lookup name */
166 &auth_tls_options_count,
167 &auth_tls_option_defaults,
168 sizeof(auth_tls_options_block),
169 auth_tls_init, /* init function */
170 auth_tls_server, /* server function */
171 NULL, /* client function */
172 NULL /* diagnostic function */
176 { US"", NULL, NULL, NULL, 0, NULL, NULL, NULL, NULL }
180 /* Tables of information about which routers and transports are included in the
183 /* Pull in the necessary header files */
185 #include "routers/rf_functions.h"
188 #include "routers/accept.h"
191 #ifdef ROUTER_DNSLOOKUP
192 #include "routers/dnslookup.h"
195 #ifdef ROUTER_MANUALROUTE
196 #include "routers/manualroute.h"
199 #ifdef ROUTER_IPLITERAL
200 #include "routers/ipliteral.h"
203 #ifdef ROUTER_IPLOOKUP
204 #include "routers/iplookup.h"
207 #ifdef ROUTER_QUERYPROGRAM
208 #include "routers/queryprogram.h"
211 #ifdef ROUTER_REDIRECT
212 #include "routers/redirect.h"
215 #ifdef TRANSPORT_APPENDFILE
216 #include "transports/appendfile.h"
219 #ifdef TRANSPORT_AUTOREPLY
220 #include "transports/autoreply.h"
223 #ifdef TRANSPORT_LMTP
224 #include "transports/lmtp.h"
227 #ifdef TRANSPORT_PIPE
228 #include "transports/pipe.h"
231 #ifdef TRANSPORT_SMTP
232 #include "transports/smtp.h"
236 /* Now set up the structures, terminated by an entry with a null name. */
238 router_info routers_available[] = {
242 accept_router_options,
243 &accept_router_options_count,
244 &accept_router_option_defaults,
245 sizeof(accept_router_options_block),
248 NULL, /* no tidyup entry */
252 #ifdef ROUTER_DNSLOOKUP
255 dnslookup_router_options,
256 &dnslookup_router_options_count,
257 &dnslookup_router_option_defaults,
258 sizeof(dnslookup_router_options_block),
259 dnslookup_router_init,
260 dnslookup_router_entry,
261 NULL, /* no tidyup entry */
265 #ifdef ROUTER_IPLITERAL
268 ipliteral_router_options,
269 &ipliteral_router_options_count,
270 &ipliteral_router_option_defaults,
271 sizeof(ipliteral_router_options_block),
272 ipliteral_router_init,
273 ipliteral_router_entry,
274 NULL, /* no tidyup entry */
278 #ifdef ROUTER_IPLOOKUP
281 iplookup_router_options,
282 &iplookup_router_options_count,
283 &iplookup_router_option_defaults,
284 sizeof(iplookup_router_options_block),
285 iplookup_router_init,
286 iplookup_router_entry,
287 NULL, /* no tidyup entry */
291 #ifdef ROUTER_MANUALROUTE
294 manualroute_router_options,
295 &manualroute_router_options_count,
296 &manualroute_router_option_defaults,
297 sizeof(manualroute_router_options_block),
298 manualroute_router_init,
299 manualroute_router_entry,
300 NULL, /* no tidyup entry */
304 #ifdef ROUTER_QUERYPROGRAM
307 queryprogram_router_options,
308 &queryprogram_router_options_count,
309 &queryprogram_router_option_defaults,
310 sizeof(queryprogram_router_options_block),
311 queryprogram_router_init,
312 queryprogram_router_entry,
313 NULL, /* no tidyup entry */
317 #ifdef ROUTER_REDIRECT
320 redirect_router_options,
321 &redirect_router_options_count,
322 &redirect_router_option_defaults,
323 sizeof(redirect_router_options_block),
324 redirect_router_init,
325 redirect_router_entry,
326 NULL, /* no tidyup entry */
330 { US"", NULL, NULL, NULL, 0, NULL, NULL, NULL, 0 }
335 transport_info transports_available[] = {
336 #ifdef TRANSPORT_APPENDFILE
338 US"appendfile", /* driver name */
339 appendfile_transport_options, /* local options table */
340 &appendfile_transport_options_count, /* number of entries */
341 &appendfile_transport_option_defaults, /* private options defaults */
342 sizeof(appendfile_transport_options_block), /* size of private block */
343 appendfile_transport_init, /* init entry point */
344 appendfile_transport_entry, /* main entry point */
345 NULL, /* no tidyup entry */
346 NULL, /* no closedown entry */
347 TRUE, /* local flag */
350 #ifdef TRANSPORT_AUTOREPLY
352 US"autoreply", /* driver name */
353 autoreply_transport_options, /* local options table */
354 &autoreply_transport_options_count, /* number of entries */
355 &autoreply_transport_option_defaults, /* private options defaults */
356 sizeof(autoreply_transport_options_block), /* size of private block */
357 autoreply_transport_init, /* init entry point */
358 autoreply_transport_entry, /* main entry point */
359 NULL, /* no tidyup entry */
360 NULL, /* no closedown entry */
361 TRUE /* local flag */
364 #ifdef TRANSPORT_LMTP
366 US"lmtp", /* driver name */
367 lmtp_transport_options, /* local options table */
368 &lmtp_transport_options_count, /* number of entries */
369 &lmtp_transport_option_defaults, /* private options defaults */
370 sizeof(lmtp_transport_options_block), /* size of private block */
371 lmtp_transport_init, /* init entry point */
372 lmtp_transport_entry, /* main entry point */
373 NULL, /* no tidyup entry */
374 NULL, /* no closedown entry */
375 TRUE /* local flag */
378 #ifdef TRANSPORT_PIPE
380 US"pipe", /* driver name */
381 pipe_transport_options, /* local options table */
382 &pipe_transport_options_count, /* number of entries */
383 &pipe_transport_option_defaults, /* private options defaults */
384 sizeof(pipe_transport_options_block), /* size of private block */
385 pipe_transport_init, /* init entry point */
386 pipe_transport_entry, /* main entry point */
387 NULL, /* no tidyup entry */
388 NULL, /* no closedown entry */
389 TRUE /* local flag */
392 #ifdef TRANSPORT_SMTP
394 US"smtp", /* driver name */
395 smtp_transport_options, /* local options table */
396 &smtp_transport_options_count, /* number of entries */
397 &smtp_transport_option_defaults, /* private options defaults */
398 sizeof(smtp_transport_options_block), /* size of private block */
399 smtp_transport_init, /* init entry point */
400 smtp_transport_entry, /* main entry point */
401 NULL, /* no tidyup entry */
402 smtp_transport_closedown, /* close down passed channel */
403 FALSE /* local flag */
406 { US"", NULL, NULL, NULL, 0, NULL, NULL, NULL, NULL, FALSE }
409 struct lookupmodulestr
412 struct lookup_module_info *info;
413 struct lookupmodulestr *next;
416 static struct lookupmodulestr *lookupmodules = NULL;
419 addlookupmodule(void *dl, struct lookup_module_info *info)
421 struct lookupmodulestr *p = store_malloc(sizeof(struct lookupmodulestr));
425 p->next = lookupmodules;
427 lookup_list_count += info->lookupcount;
430 /* only valid after lookup_list and lookup_list_count are assigned */
432 add_lookup_to_list(lookup_info *info)
434 /* need to add the lookup to lookup_list, sorted */
437 /* strategy is to go through the list until we find
438 either an empty spot or a name that is higher.
439 this can't fail because we have enough space. */
441 while (lookup_list[pos] && (Ustrcmp(lookup_list[pos]->name, info->name) <= 0))
444 if (lookup_list[pos])
446 /* need to insert it, so move all the other items up
447 (last slot is still empty, of course) */
449 memmove(&lookup_list[pos+1],
451 sizeof(lookup_info *) * (lookup_list_count-pos-1));
453 lookup_list[pos] = info;
457 /* These need to be at file level for old versions of gcc (2.95.2 reported),
458 * which give parse errors on an extern in function scope. Each entry needs
459 * to also be invoked in init_lookup_list() below */
461 #if defined(LOOKUP_CDB) && LOOKUP_CDB!=2
462 extern lookup_module_info cdb_lookup_module_info;
464 #if defined(LOOKUP_DBM) && LOOKUP_DBM!=2
465 extern lookup_module_info dbmdb_lookup_module_info;
467 #if defined(LOOKUP_DNSDB) && LOOKUP_DNSDB!=2
468 extern lookup_module_info dnsdb_lookup_module_info;
470 #if defined(LOOKUP_DSEARCH) && LOOKUP_DSEARCH!=2
471 extern lookup_module_info dsearch_lookup_module_info;
473 #if defined(LOOKUP_IBASE) && LOOKUP_IBASE!=2
474 extern lookup_module_info ibase_lookup_module_info;
476 #if defined(LOOKUP_LDAP)
477 extern lookup_module_info ldap_lookup_module_info;
479 #if defined(LOOKUP_LSEARCH) && LOOKUP_LSEARCH!=2
480 extern lookup_module_info lsearch_lookup_module_info;
482 #if defined(LOOKUP_MYSQL) && LOOKUP_MYSQL!=2
483 extern lookup_module_info mysql_lookup_module_info;
485 #if defined(LOOKUP_NIS) && LOOKUP_NIS!=2
486 extern lookup_module_info nis_lookup_module_info;
488 #if defined(LOOKUP_NISPLUS) && LOOKUP_NISPLUS!=2
489 extern lookup_module_info nisplus_lookup_module_info;
491 #if defined(LOOKUP_ORACLE) && LOOKUP_ORACLE!=2
492 extern lookup_module_info oracle_lookup_module_info;
494 #if defined(LOOKUP_PASSWD) && LOOKUP_PASSWD!=2
495 extern lookup_module_info passwd_lookup_module_info;
497 #if defined(LOOKUP_PGSQL) && LOOKUP_PGSQL!=2
498 extern lookup_module_info pgsql_lookup_module_info;
500 #if defined(LOOKUP_REDIS) && LOOKUP_REDIS!=2
501 extern lookup_module_info redis_lookup_module_info;
503 #if defined(EXPERIMENTAL_LMDB)
504 extern lookup_module_info lmdb_lookup_module_info;
506 #if defined(EXPERIMENTAL_SPF)
507 extern lookup_module_info spf_lookup_module_info;
509 #if defined(LOOKUP_SQLITE) && LOOKUP_SQLITE!=2
510 extern lookup_module_info sqlite_lookup_module_info;
512 #if defined(LOOKUP_TESTDB) && LOOKUP_TESTDB!=2
513 extern lookup_module_info testdb_lookup_module_info;
515 #if defined(LOOKUP_WHOSON) && LOOKUP_WHOSON!=2
516 extern lookup_module_info whoson_lookup_module_info;
521 init_lookup_list(void)
523 #ifdef LOOKUP_MODULE_DIR
526 int countmodules = 0;
527 int moduleerrors = 0;
529 struct lookupmodulestr *p;
531 if (lookup_list_init_done)
533 lookup_list_init_done = 1;
535 #if defined(LOOKUP_CDB) && LOOKUP_CDB!=2
536 addlookupmodule(NULL, &cdb_lookup_module_info);
539 #if defined(LOOKUP_DBM) && LOOKUP_DBM!=2
540 addlookupmodule(NULL, &dbmdb_lookup_module_info);
543 #if defined(LOOKUP_DNSDB) && LOOKUP_DNSDB!=2
544 addlookupmodule(NULL, &dnsdb_lookup_module_info);
547 #if defined(LOOKUP_DSEARCH) && LOOKUP_DSEARCH!=2
548 addlookupmodule(NULL, &dsearch_lookup_module_info);
551 #if defined(LOOKUP_IBASE) && LOOKUP_IBASE!=2
552 addlookupmodule(NULL, &ibase_lookup_module_info);
556 addlookupmodule(NULL, &ldap_lookup_module_info);
559 #if defined(LOOKUP_LSEARCH) && LOOKUP_LSEARCH!=2
560 addlookupmodule(NULL, &lsearch_lookup_module_info);
563 #if defined(LOOKUP_MYSQL) && LOOKUP_MYSQL!=2
564 addlookupmodule(NULL, &mysql_lookup_module_info);
567 #if defined(LOOKUP_NIS) && LOOKUP_NIS!=2
568 addlookupmodule(NULL, &nis_lookup_module_info);
571 #if defined(LOOKUP_NISPLUS) && LOOKUP_NISPLUS!=2
572 addlookupmodule(NULL, &nisplus_lookup_module_info);
575 #if defined(LOOKUP_ORACLE) && LOOKUP_ORACLE!=2
576 addlookupmodule(NULL, &oracle_lookup_module_info);
579 #if defined(LOOKUP_PASSWD) && LOOKUP_PASSWD!=2
580 addlookupmodule(NULL, &passwd_lookup_module_info);
583 #if defined(LOOKUP_PGSQL) && LOOKUP_PGSQL!=2
584 addlookupmodule(NULL, &pgsql_lookup_module_info);
587 #if defined(LOOKUP_REDIS) && LOOKUP_REDIS!=2
588 addlookupmodule(NULL, &redis_lookup_module_info);
591 #ifdef EXPERIMENTAL_LMDB
592 addlookupmodule(NULL, &lmdb_lookup_module_info);
595 #ifdef EXPERIMENTAL_SPF
596 addlookupmodule(NULL, &spf_lookup_module_info);
599 #if defined(LOOKUP_SQLITE) && LOOKUP_SQLITE!=2
600 addlookupmodule(NULL, &sqlite_lookup_module_info);
603 #if defined(LOOKUP_TESTDB) && LOOKUP_TESTDB!=2
604 addlookupmodule(NULL, &testdb_lookup_module_info);
607 #if defined(LOOKUP_WHOSON) && LOOKUP_WHOSON!=2
608 addlookupmodule(NULL, &whoson_lookup_module_info);
611 #ifdef LOOKUP_MODULE_DIR
612 dd = opendir(LOOKUP_MODULE_DIR);
614 DEBUG(D_lookup) debug_printf("Couldn't open %s: not loading lookup modules\n", LOOKUP_MODULE_DIR);
615 log_write(0, LOG_MAIN, "Couldn't open %s: not loading lookup modules\n", LOOKUP_MODULE_DIR);
618 const pcre *regex_islookupmod = regex_must_compile(
619 US"\\." DYNLIB_FN_EXT "$", FALSE, TRUE);
621 DEBUG(D_lookup) debug_printf("Loading lookup modules from %s\n", LOOKUP_MODULE_DIR);
622 while ((ent = readdir(dd)) != NULL) {
623 char *name = ent->d_name;
624 int len = (int)strlen(name);
625 if (pcre_exec(regex_islookupmod, NULL, name, len, 0, PCRE_EOPT, NULL, 0) >= 0) {
626 int pathnamelen = len + (int)strlen(LOOKUP_MODULE_DIR) + 2;
628 struct lookup_module_info *info;
629 const char *errormsg;
631 /* SRH: am I being paranoid here or what? */
632 if (pathnamelen > big_buffer_size) {
633 fprintf(stderr, "Loading lookup modules: %s/%s: name too long\n", LOOKUP_MODULE_DIR, name);
634 log_write(0, LOG_MAIN|LOG_PANIC, "%s/%s: name too long\n", LOOKUP_MODULE_DIR, name);
638 /* SRH: snprintf here? */
639 sprintf(CS big_buffer, "%s/%s", LOOKUP_MODULE_DIR, name);
641 dl = dlopen(CS big_buffer, RTLD_NOW);// TJ was LAZY
643 fprintf(stderr, "Error loading %s: %s\n", name, dlerror());
645 log_write(0, LOG_MAIN|LOG_PANIC, "Error loading lookup module %s: %s\n", name, dlerror());
649 /* FreeBSD nsdispatch() can trigger dlerror() errors about
650 * _nss_cache_cycle_prevention_function; we need to clear the dlerror()
651 * state before calling dlsym(), so that any error afterwards only
652 * comes from dlsym().
654 errormsg = dlerror();
656 info = (struct lookup_module_info*) dlsym(dl, "_lookup_module_info");
657 if ((errormsg = dlerror()) != NULL) {
658 fprintf(stderr, "%s does not appear to be a lookup module (%s)\n", name, errormsg);
661 log_write(0, LOG_MAIN|LOG_PANIC, "%s does not appear to be a lookup module (%s)\n", name, errormsg);
664 if (info->magic != LOOKUP_MODULE_INFO_MAGIC) {
665 fprintf(stderr, "Lookup module %s is not compatible with this version of Exim\n", name);
668 log_write(0, LOG_MAIN|LOG_PANIC, "Lookup module %s is not compatible with this version of Exim\n", name);
672 addlookupmodule(dl, info);
673 DEBUG(D_lookup) debug_printf("Loaded \"%s\" (%d lookup types)\n", name, info->lookupcount);
677 store_free((void*)regex_islookupmod);
681 DEBUG(D_lookup) debug_printf("Loaded %d lookup modules\n", countmodules);
684 DEBUG(D_lookup) debug_printf("Total %d lookups\n", lookup_list_count);
686 lookup_list = store_malloc(sizeof(lookup_info *) * lookup_list_count);
687 memset(lookup_list, 0, sizeof(lookup_info *) * lookup_list_count);
689 /* now add all lookups to the real list */
693 struct lookupmodulestr *pnext;
695 for (j = 0; j < p->info->lookupcount; j++)
696 add_lookup_to_list(p->info->lookups[j]);
702 /* just to be sure */
703 lookupmodules = NULL;
706 /* End of drtables.c */