2 * checkconf/unbound-checkconf.c - config file checker for unbound.conf file.
4 * Copyright (c) 2007, NLnet Labs. All rights reserved.
6 * This software is open source.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
15 * Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
19 * Neither the name of the NLNET LABS nor the names of its contributors may
20 * be used to endorse or promote products derived from this software without
21 * specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
29 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 * The config checker checks for syntax and other errors in the unbound.conf
40 * file, and can be used to check for errors before the server is started
42 * Exit status 1 means an error.
47 #include "util/config_file.h"
48 #include "util/module.h"
49 #include "util/net_help.h"
50 #include "util/regional.h"
51 #include "iterator/iterator.h"
52 #include "iterator/iter_fwd.h"
53 #include "iterator/iter_hints.h"
54 #include "validator/validator.h"
55 #include "services/localzone.h"
56 #include "services/view.h"
57 #include "respip/respip.h"
58 #include "sldns/sbuffer.h"
65 #ifdef HAVE_SYS_STAT_H
71 #ifdef WITH_PYTHONMODULE
72 #include "pythonmod/pythonmod.h"
75 /** Give checkconf usage, and exit (1). */
79 printf("Usage: unbound-checkconf [file]\n");
80 printf(" Checks unbound configuration file for errors.\n");
81 printf("file if omitted %s is used.\n", CONFIGFILE);
82 printf("-o option print value of option to stdout.\n");
83 printf("-f output full pathname with chroot applied, eg. with -o pidfile.\n");
84 printf("-h show this usage help.\n");
85 printf("Version %s\n", PACKAGE_VERSION);
86 printf("BSD licensed, see LICENSE in source package for details.\n");
87 printf("Report bugs to %s\n", PACKAGE_BUGREPORT);
92 * Print given option to stdout
94 * @param opt: option name without trailing :.
95 * This is different from config_set_option.
96 * @param final: if final pathname with chroot applied has to be printed.
99 print_option(struct config_file* cfg, const char* opt, int final)
101 if(strcmp(opt, "pidfile") == 0 && final) {
102 char *p = fname_after_chroot(cfg->pidfile, cfg, 1);
103 if(!p) fatal_exit("out of memory");
108 if(!config_get_option(cfg, opt, config_print_func, stdout))
109 fatal_exit("cannot print option '%s'", opt);
112 /** check if module works with config */
114 check_mod(struct config_file* cfg, struct module_func_block* fb)
116 struct module_env env;
117 memset(&env, 0, sizeof(env));
119 env.scratch = regional_create();
120 env.scratch_buffer = sldns_buffer_new(BUFSIZ);
121 if(!env.scratch || !env.scratch_buffer)
122 fatal_exit("out of memory");
123 if(!edns_known_options_init(&env))
124 fatal_exit("out of memory");
125 if(!(*fb->init)(&env, 0)) {
126 fatal_exit("bad config for %s module", fb->name);
128 (*fb->deinit)(&env, 0);
129 sldns_buffer_free(env.scratch_buffer);
130 regional_destroy(env.scratch);
131 edns_known_options_delete(&env);
134 /** check localzones */
136 localzonechecks(struct config_file* cfg)
138 struct local_zones* zs;
139 if(!(zs = local_zones_create()))
140 fatal_exit("out of memory");
141 if(!local_zones_apply_cfg(zs, cfg))
142 fatal_exit("failed local-zone, local-data configuration");
143 local_zones_delete(zs);
146 /** check view and response-ip configuration */
148 view_and_respipchecks(struct config_file* cfg)
150 struct views* views = NULL;
151 struct respip_set* respip = NULL;
153 if(!(views = views_create()))
154 fatal_exit("Could not create views: out of memory");
155 if(!(respip = respip_set_create()))
156 fatal_exit("Could not create respip set: out of memory");
157 if(!views_apply_cfg(views, cfg))
158 fatal_exit("Could not set up views");
159 if(!respip_global_apply_cfg(respip, cfg))
160 fatal_exit("Could not setup respip set");
161 if(!respip_views_apply_cfg(views, cfg, &ignored))
162 fatal_exit("Could not setup per-view respip sets");
164 respip_set_delete(respip);
167 /** emit warnings for IP in hosts */
169 warn_hosts(const char* typ, struct config_stub* list)
171 struct sockaddr_storage a;
173 struct config_stub* s;
174 struct config_strlist* h;
175 for(s=list; s; s=s->next) {
176 for(h=s->hosts; h; h=h->next) {
177 if(extstrtoaddr(h->str, &a, &alen)) {
178 fprintf(stderr, "unbound-checkconf: warning:"
179 " %s %s: \"%s\" is an IP%s address, "
180 "and when looked up as a host name "
181 "during use may not resolve.\n",
182 s->name, typ, h->str,
183 addr_is_ip6(&a, alen)?"6":"4");
189 /** check interface strings */
191 interfacechecks(struct config_file* cfg)
194 struct sockaddr_storage a;
197 for(i=0; i<cfg->num_ifs; i++) {
198 if(!extstrtoaddr(cfg->ifs[i], &a, &alen)) {
199 fatal_exit("cannot parse interface specified as '%s'",
202 for(j=0; j<cfg->num_ifs; j++) {
203 if(i!=j && strcmp(cfg->ifs[i], cfg->ifs[j])==0)
204 fatal_exit("interface: %s present twice, "
205 "cannot bind same ports twice.",
209 for(i=0; i<cfg->num_out_ifs; i++) {
210 if(!ipstrtoaddr(cfg->out_ifs[i], UNBOUND_DNS_PORT, &a, &alen) &&
211 !netblockstrtoaddr(cfg->out_ifs[i], UNBOUND_DNS_PORT, &a, &alen, &d)) {
212 fatal_exit("cannot parse outgoing-interface "
213 "specified as '%s'", cfg->out_ifs[i]);
215 for(j=0; j<cfg->num_out_ifs; j++) {
216 if(i!=j && strcmp(cfg->out_ifs[i], cfg->out_ifs[j])==0)
217 fatal_exit("outgoing-interface: %s present "
218 "twice, cannot bind same ports twice.",
226 aclchecks(struct config_file* cfg)
229 struct sockaddr_storage a;
231 struct config_str2list* acl;
232 for(acl=cfg->acls; acl; acl = acl->next) {
233 if(!netblockstrtoaddr(acl->str, UNBOUND_DNS_PORT, &a, &alen,
235 fatal_exit("cannot parse access control address %s %s",
236 acl->str, acl->str2);
241 /** true if fname is a file */
243 is_file(const char* fname)
246 if(stat(fname, &buf) < 0) {
248 printf("warning: no search permission for one of the directories in path: %s\n", fname);
254 if(S_ISDIR(buf.st_mode)) {
255 printf("%s is not a file\n", fname);
261 /** true if fname is a directory */
263 is_dir(const char* fname)
266 if(stat(fname, &buf) < 0) {
268 printf("warning: no search permission for one of the directories in path: %s\n", fname);
274 if(!(S_ISDIR(buf.st_mode))) {
275 printf("%s is not a directory\n", fname);
281 /** get base dir of a fname */
286 if(!fname) fatal_exit("out of memory");
287 rev = strrchr(fname, '/');
288 if(!rev) return NULL;
289 if(fname == rev) return NULL;
294 /** check chroot for a file string */
296 check_chroot_string(const char* desc, char** ss,
297 const char* chrootdir, struct config_file* cfg)
301 *ss = fname_after_chroot(str, cfg, 1);
302 if(!*ss) fatal_exit("out of memory");
304 if(chrootdir && chrootdir[0])
305 fatal_exit("%s: \"%s\" does not exist in "
306 "chrootdir %s", desc, str, chrootdir);
308 fatal_exit("%s: \"%s\" does not exist",
311 /* put in a new full path for continued checking */
316 /** check file list, every file must be inside the chroot location */
318 check_chroot_filelist(const char* desc, struct config_strlist* list,
319 const char* chrootdir, struct config_file* cfg)
321 struct config_strlist* p;
322 for(p=list; p; p=p->next) {
323 check_chroot_string(desc, &p->str, chrootdir, cfg);
327 /** check file list, with wildcard processing */
329 check_chroot_filelist_wild(const char* desc, struct config_strlist* list,
330 const char* chrootdir, struct config_file* cfg)
332 struct config_strlist* p;
333 for(p=list; p; p=p->next) {
335 if(strchr(p->str, '*') || strchr(p->str, '[') ||
336 strchr(p->str, '?') || strchr(p->str, '{') ||
337 strchr(p->str, '~')) {
339 /* adjust whole pattern for chroot and check later */
340 p->str = fname_after_chroot(p->str, cfg, 1);
343 #endif /* HAVE_GLOB */
344 check_chroot_string(desc, &p->str, chrootdir, cfg);
348 /** check configuration for errors */
350 morechecks(struct config_file* cfg, const char* fname)
352 warn_hosts("stub-host", cfg->stubs);
353 warn_hosts("forward-host", cfg->forwards);
354 interfacechecks(cfg);
357 if(cfg->verbosity < 0)
358 fatal_exit("verbosity value < 0");
359 if(cfg->num_threads <= 0 || cfg->num_threads > 10000)
360 fatal_exit("num_threads value weird");
361 if(!cfg->do_ip4 && !cfg->do_ip6)
362 fatal_exit("ip4 and ip6 are both disabled, pointless");
363 if(!cfg->do_ip6 && cfg->prefer_ip6)
364 fatal_exit("cannot prefer and disable ip6, pointless");
365 if(!cfg->do_udp && !cfg->do_tcp)
366 fatal_exit("udp and tcp are both disabled, pointless");
367 if(cfg->edns_buffer_size > cfg->msg_buffer_size)
368 fatal_exit("edns-buffer-size larger than msg-buffer-size, "
369 "answers will not fit in processing buffer");
371 w_config_adjust_directory(cfg);
373 if(cfg->chrootdir && cfg->chrootdir[0] &&
374 cfg->chrootdir[strlen(cfg->chrootdir)-1] == '/')
375 fatal_exit("chootdir %s has trailing slash '/' please remove.",
377 if(cfg->chrootdir && cfg->chrootdir[0] &&
378 !is_dir(cfg->chrootdir)) {
379 fatal_exit("bad chroot directory");
381 if(cfg->chrootdir && cfg->chrootdir[0]) {
384 if(fname[0] != '/') {
385 if(getcwd(buf, sizeof(buf)) == NULL)
386 fatal_exit("getcwd: %s", strerror(errno));
387 (void)strlcat(buf, "/", sizeof(buf));
389 (void)strlcat(buf, fname, sizeof(buf));
390 if(strncmp(buf, cfg->chrootdir, strlen(cfg->chrootdir)) != 0)
391 fatal_exit("config file %s is not inside chroot %s",
392 buf, cfg->chrootdir);
394 if(cfg->directory && cfg->directory[0]) {
395 char* ad = fname_after_chroot(cfg->directory, cfg, 0);
396 if(!ad) fatal_exit("out of memory");
397 if(!is_dir(ad)) fatal_exit("bad chdir directory");
400 if( (cfg->chrootdir && cfg->chrootdir[0]) ||
401 (cfg->directory && cfg->directory[0])) {
402 if(cfg->pidfile && cfg->pidfile[0]) {
403 char* ad = (cfg->pidfile[0]=='/')?strdup(cfg->pidfile):
404 fname_after_chroot(cfg->pidfile, cfg, 1);
405 char* bd = basedir(ad);
406 if(bd && !is_dir(bd))
407 fatal_exit("pidfile directory does not exist");
410 if(cfg->logfile && cfg->logfile[0]) {
411 char* ad = fname_after_chroot(cfg->logfile, cfg, 1);
412 char* bd = basedir(ad);
413 if(bd && !is_dir(bd))
414 fatal_exit("logfile directory does not exist");
419 check_chroot_filelist("file with root-hints",
420 cfg->root_hints, cfg->chrootdir, cfg);
421 check_chroot_filelist("trust-anchor-file",
422 cfg->trust_anchor_file_list, cfg->chrootdir, cfg);
423 check_chroot_filelist("auto-trust-anchor-file",
424 cfg->auto_trust_anchor_file_list, cfg->chrootdir, cfg);
425 check_chroot_filelist_wild("trusted-keys-file",
426 cfg->trusted_keys_file_list, cfg->chrootdir, cfg);
427 check_chroot_string("dlv-anchor-file", &cfg->dlv_anchor_file,
428 cfg->chrootdir, cfg);
430 check_chroot_string("ipsecmod-hook", &cfg->ipsecmod_hook, cfg->chrootdir,
433 /* remove chroot setting so that modules are not stripping pathnames*/
434 free(cfg->chrootdir);
435 cfg->chrootdir = NULL;
437 /* There should be no reason for 'respip' module not to work with
438 * dns64, but it's not explicitly confirmed, so the combination is
439 * excluded below. It's simply unknown yet for the combination of
440 * respip and other modules. */
441 if(strcmp(cfg->module_conf, "iterator") != 0
442 && strcmp(cfg->module_conf, "validator iterator") != 0
443 && strcmp(cfg->module_conf, "dns64 validator iterator") != 0
444 && strcmp(cfg->module_conf, "dns64 iterator") != 0
445 && strcmp(cfg->module_conf, "respip iterator") != 0
446 && strcmp(cfg->module_conf, "respip validator iterator") != 0
447 #ifdef WITH_PYTHONMODULE
448 && strcmp(cfg->module_conf, "python iterator") != 0
449 && strcmp(cfg->module_conf, "python validator iterator") != 0
450 && strcmp(cfg->module_conf, "validator python iterator") != 0
451 && strcmp(cfg->module_conf, "dns64 python iterator") != 0
452 && strcmp(cfg->module_conf, "dns64 python validator iterator") != 0
453 && strcmp(cfg->module_conf, "dns64 validator python iterator") != 0
454 && strcmp(cfg->module_conf, "python dns64 iterator") != 0
455 && strcmp(cfg->module_conf, "python dns64 validator iterator") != 0
458 && strcmp(cfg->module_conf, "validator cachedb iterator") != 0
459 && strcmp(cfg->module_conf, "cachedb iterator") != 0
460 && strcmp(cfg->module_conf, "dns64 validator cachedb iterator") != 0
461 && strcmp(cfg->module_conf, "dns64 cachedb iterator") != 0
463 #if defined(WITH_PYTHONMODULE) && defined(USE_CACHEDB)
464 && strcmp(cfg->module_conf, "python dns64 cachedb iterator") != 0
465 && strcmp(cfg->module_conf, "python dns64 validator cachedb iterator") != 0
466 && strcmp(cfg->module_conf, "dns64 python cachedb iterator") != 0
467 && strcmp(cfg->module_conf, "dns64 python validator cachedb iterator") != 0
468 && strcmp(cfg->module_conf, "python cachedb iterator") != 0
469 && strcmp(cfg->module_conf, "python validator cachedb iterator") != 0
470 && strcmp(cfg->module_conf, "cachedb python iterator") != 0
471 && strcmp(cfg->module_conf, "validator cachedb python iterator") != 0
472 && strcmp(cfg->module_conf, "validator python cachedb iterator") != 0
475 && strcmp(cfg->module_conf, "subnetcache iterator") != 0
476 && strcmp(cfg->module_conf, "subnetcache validator iterator") != 0
478 #if defined(WITH_PYTHONMODULE) && defined(CLIENT_SUBNET)
479 && strcmp(cfg->module_conf, "python subnetcache iterator") != 0
480 && strcmp(cfg->module_conf, "subnetcache python iterator") != 0
481 && strcmp(cfg->module_conf, "subnetcache validator iterator") != 0
482 && strcmp(cfg->module_conf, "python subnetcache validator iterator") != 0
483 && strcmp(cfg->module_conf, "subnetcache python validator iterator") != 0
484 && strcmp(cfg->module_conf, "subnetcache validator python iterator") != 0
487 && strcmp(cfg->module_conf, "ipsecmod iterator") != 0
488 && strcmp(cfg->module_conf, "ipsecmod validator iterator") != 0
490 #if defined(WITH_PYTHONMODULE) && defined(USE_IPSECMOD)
491 && strcmp(cfg->module_conf, "python ipsecmod iterator") != 0
492 && strcmp(cfg->module_conf, "ipsecmod python iterator") != 0
493 && strcmp(cfg->module_conf, "ipsecmod validator iterator") != 0
494 && strcmp(cfg->module_conf, "python ipsecmod validator iterator") != 0
495 && strcmp(cfg->module_conf, "ipsecmod python validator iterator") != 0
496 && strcmp(cfg->module_conf, "ipsecmod validator python iterator") != 0
499 fatal_exit("module conf '%s' is not known to work",
504 if(cfg->username && cfg->username[0]) {
505 if(getpwnam(cfg->username) == NULL)
506 fatal_exit("user '%s' does not exist.", cfg->username);
507 # ifdef HAVE_ENDPWENT
512 if(cfg->remote_control_enable && cfg->remote_control_use_cert) {
513 check_chroot_string("server-key-file", &cfg->server_key_file,
514 cfg->chrootdir, cfg);
515 check_chroot_string("server-cert-file", &cfg->server_cert_file,
516 cfg->chrootdir, cfg);
517 if(!is_file(cfg->control_key_file))
518 fatal_exit("control-key-file: \"%s\" does not exist",
519 cfg->control_key_file);
520 if(!is_file(cfg->control_cert_file))
521 fatal_exit("control-cert-file: \"%s\" does not exist",
522 cfg->control_cert_file);
525 localzonechecks(cfg);
526 view_and_respipchecks(cfg);
529 /** check forwards */
531 check_fwd(struct config_file* cfg)
533 struct iter_forwards* fwd = forwards_create();
534 if(!fwd || !forwards_apply_cfg(fwd, cfg)) {
535 fatal_exit("Could not set forward zones");
537 forwards_delete(fwd);
542 check_hints(struct config_file* cfg)
544 struct iter_hints* hints = hints_create();
545 if(!hints || !hints_apply_cfg(hints, cfg)) {
546 fatal_exit("Could not set root or stub hints");
551 /** check config file */
553 checkconf(const char* cfgfile, const char* opt, int final)
556 struct config_file* cfg = config_create();
558 fatal_exit("out of memory");
560 if(!getcwd(oldwd, sizeof(oldwd))) {
561 log_err("cannot getcwd: %s", strerror(errno));
564 if(!config_read(cfg, cfgfile, NULL)) {
565 /* config_read prints messages to stderr */
569 if(oldwd[0] && chdir(oldwd) == -1)
570 log_err("cannot chdir(%s): %s", oldwd, strerror(errno));
572 print_option(cfg, opt, final);
576 morechecks(cfg, cfgfile);
577 check_mod(cfg, iter_get_funcblock());
578 check_mod(cfg, val_get_funcblock());
579 #ifdef WITH_PYTHONMODULE
580 if(strstr(cfg->module_conf, "python"))
581 check_mod(cfg, pythonmod_get_funcblock());
585 printf("unbound-checkconf: no errors in %s\n", cfgfile);
589 /** getopt global, in case header files fail to declare it. */
591 /** getopt global, in case header files fail to declare it. */
594 /** Main routine for checkconf */
595 int main(int argc, char* argv[])
600 const char* opt = NULL;
601 const char* cfgfile = CONFIGFILE;
602 log_ident_set("unbound-checkconf");
603 log_init(NULL, 0, NULL);
606 /* use registry config file in preference to compiletime location */
607 if(!(cfgfile=w_lookup_reg_str("Software\\Unbound", "ConfigFile")))
608 cfgfile = CONFIGFILE;
609 #endif /* USE_WINSOCK */
610 /* parse the options */
611 while( (c=getopt(argc, argv, "fho:")) != -1) {
627 if(argc != 0 && argc != 1)
632 checkconf(f, opt, final);