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 "ldns/sbuffer.h"
63 #ifdef HAVE_SYS_STAT_H
69 #ifdef WITH_PYTHONMODULE
70 #include "pythonmod/pythonmod.h"
73 /** Give checkconf usage, and exit (1). */
77 printf("Usage: unbound-checkconf [file]\n");
78 printf(" Checks unbound configuration file for errors.\n");
79 printf("file if omitted %s is used.\n", CONFIGFILE);
80 printf("-o option print value of option to stdout.\n");
81 printf("-h show this usage help.\n");
82 printf("Version %s\n", PACKAGE_VERSION);
83 printf("BSD licensed, see LICENSE in source package for details.\n");
84 printf("Report bugs to %s\n", PACKAGE_BUGREPORT);
89 * Print given option to stdout
91 * @param opt: option name without trailing :.
92 * This is different from config_set_option.
95 print_option(struct config_file* cfg, const char* opt)
97 if(!config_get_option(cfg, opt, config_print_func, stdout))
98 fatal_exit("cannot print option '%s'", opt);
101 /** check if module works with config */
103 check_mod(struct config_file* cfg, struct module_func_block* fb)
105 struct module_env env;
106 memset(&env, 0, sizeof(env));
108 env.scratch = regional_create();
109 env.scratch_buffer = sldns_buffer_new(BUFSIZ);
110 if(!env.scratch || !env.scratch_buffer)
111 fatal_exit("out of memory");
112 if(!(*fb->init)(&env, 0)) {
113 fatal_exit("bad config for %s module", fb->name);
115 (*fb->deinit)(&env, 0);
116 sldns_buffer_free(env.scratch_buffer);
117 regional_destroy(env.scratch);
120 /** check localzones */
122 localzonechecks(struct config_file* cfg)
124 struct local_zones* zs;
125 if(!(zs = local_zones_create()))
126 fatal_exit("out of memory");
127 if(!local_zones_apply_cfg(zs, cfg))
128 fatal_exit("failed local-zone, local-data configuration");
129 local_zones_delete(zs);
132 /** emit warnings for IP in hosts */
134 warn_hosts(const char* typ, struct config_stub* list)
136 struct sockaddr_storage a;
138 struct config_stub* s;
139 struct config_strlist* h;
140 for(s=list; s; s=s->next) {
141 for(h=s->hosts; h; h=h->next) {
142 if(extstrtoaddr(h->str, &a, &alen)) {
143 fprintf(stderr, "unbound-checkconf: warning:"
144 " %s %s: \"%s\" is an IP%s address, "
145 "and when looked up as a host name "
146 "during use may not resolve.\n",
147 s->name, typ, h->str,
148 addr_is_ip6(&a, alen)?"6":"4");
154 /** check interface strings */
156 interfacechecks(struct config_file* cfg)
158 struct sockaddr_storage a;
161 for(i=0; i<cfg->num_ifs; i++) {
162 if(!extstrtoaddr(cfg->ifs[i], &a, &alen)) {
163 fatal_exit("cannot parse interface specified as '%s'",
166 for(j=0; j<cfg->num_ifs; j++) {
167 if(i!=j && strcmp(cfg->ifs[i], cfg->ifs[j])==0)
168 fatal_exit("interface: %s present twice, "
169 "cannot bind same ports twice.",
173 for(i=0; i<cfg->num_out_ifs; i++) {
174 if(!ipstrtoaddr(cfg->out_ifs[i], UNBOUND_DNS_PORT,
176 fatal_exit("cannot parse outgoing-interface "
177 "specified as '%s'", cfg->out_ifs[i]);
179 for(j=0; j<cfg->num_out_ifs; j++) {
180 if(i!=j && strcmp(cfg->out_ifs[i], cfg->out_ifs[j])==0)
181 fatal_exit("outgoing-interface: %s present "
182 "twice, cannot bind same ports twice.",
190 aclchecks(struct config_file* cfg)
193 struct sockaddr_storage a;
195 struct config_str2list* acl;
196 for(acl=cfg->acls; acl; acl = acl->next) {
197 if(!netblockstrtoaddr(acl->str, UNBOUND_DNS_PORT, &a, &alen,
199 fatal_exit("cannot parse access control address %s %s",
200 acl->str, acl->str2);
205 /** true if fname is a file */
207 is_file(const char* fname)
210 if(stat(fname, &buf) < 0) {
212 printf("warning: no search permission for one of the directories in path: %s\n", fname);
218 if(S_ISDIR(buf.st_mode)) {
219 printf("%s is not a file\n", fname);
225 /** true if fname is a directory */
227 is_dir(const char* fname)
230 if(stat(fname, &buf) < 0) {
232 printf("warning: no search permission for one of the directories in path: %s\n", fname);
238 if(!(S_ISDIR(buf.st_mode))) {
239 printf("%s is not a directory\n", fname);
245 /** get base dir of a fname */
250 if(!fname) fatal_exit("out of memory");
251 rev = strrchr(fname, '/');
252 if(!rev) return NULL;
253 if(fname == rev) return NULL;
258 /** check chroot for a file string */
260 check_chroot_string(const char* desc, char** ss,
261 const char* chrootdir, struct config_file* cfg)
265 *ss = fname_after_chroot(str, cfg, 1);
266 if(!*ss) fatal_exit("out of memory");
268 if(chrootdir && chrootdir[0])
269 fatal_exit("%s: \"%s\" does not exist in "
270 "chrootdir %s", desc, str, chrootdir);
272 fatal_exit("%s: \"%s\" does not exist",
275 /* put in a new full path for continued checking */
280 /** check file list, every file must be inside the chroot location */
282 check_chroot_filelist(const char* desc, struct config_strlist* list,
283 const char* chrootdir, struct config_file* cfg)
285 struct config_strlist* p;
286 for(p=list; p; p=p->next) {
287 check_chroot_string(desc, &p->str, chrootdir, cfg);
291 /** check file list, with wildcard processing */
293 check_chroot_filelist_wild(const char* desc, struct config_strlist* list,
294 const char* chrootdir, struct config_file* cfg)
296 struct config_strlist* p;
297 for(p=list; p; p=p->next) {
299 if(strchr(p->str, '*') || strchr(p->str, '[') ||
300 strchr(p->str, '?') || strchr(p->str, '{') ||
301 strchr(p->str, '~')) {
303 /* adjust whole pattern for chroot and check later */
304 p->str = fname_after_chroot(p->str, cfg, 1);
307 #endif /* HAVE_GLOB */
308 check_chroot_string(desc, &p->str, chrootdir, cfg);
312 /** check configuration for errors */
314 morechecks(struct config_file* cfg, const char* fname)
316 warn_hosts("stub-host", cfg->stubs);
317 warn_hosts("forward-host", cfg->forwards);
318 interfacechecks(cfg);
321 if(cfg->verbosity < 0)
322 fatal_exit("verbosity value < 0");
323 if(cfg->num_threads <= 0 || cfg->num_threads > 10000)
324 fatal_exit("num_threads value weird");
325 if(!cfg->do_ip4 && !cfg->do_ip6)
326 fatal_exit("ip4 and ip6 are both disabled, pointless");
327 if(!cfg->do_udp && !cfg->do_tcp)
328 fatal_exit("udp and tcp are both disabled, pointless");
329 if(cfg->edns_buffer_size > cfg->msg_buffer_size)
330 fatal_exit("edns-buffer-size larger than msg-buffer-size, "
331 "answers will not fit in processing buffer");
333 if(cfg->chrootdir && cfg->chrootdir[0] &&
334 cfg->chrootdir[strlen(cfg->chrootdir)-1] == '/')
335 fatal_exit("chootdir %s has trailing slash '/' please remove.",
337 if(cfg->chrootdir && cfg->chrootdir[0] &&
338 !is_dir(cfg->chrootdir)) {
339 fatal_exit("bad chroot directory");
341 if(cfg->chrootdir && cfg->chrootdir[0]) {
344 if(fname[0] != '/') {
345 if(getcwd(buf, sizeof(buf)) == NULL)
346 fatal_exit("getcwd: %s", strerror(errno));
347 (void)strlcat(buf, "/", sizeof(buf));
349 (void)strlcat(buf, fname, sizeof(buf));
350 if(strncmp(buf, cfg->chrootdir, strlen(cfg->chrootdir)) != 0)
351 fatal_exit("config file %s is not inside chroot %s",
352 buf, cfg->chrootdir);
354 if(cfg->directory && cfg->directory[0]) {
355 char* ad = fname_after_chroot(cfg->directory, cfg, 0);
356 if(!ad) fatal_exit("out of memory");
357 if(!is_dir(ad)) fatal_exit("bad chdir directory");
360 if( (cfg->chrootdir && cfg->chrootdir[0]) ||
361 (cfg->directory && cfg->directory[0])) {
362 if(cfg->pidfile && cfg->pidfile[0]) {
363 char* ad = (cfg->pidfile[0]=='/')?strdup(cfg->pidfile):
364 fname_after_chroot(cfg->pidfile, cfg, 1);
365 char* bd = basedir(ad);
366 if(bd && !is_dir(bd))
367 fatal_exit("pidfile directory does not exist");
370 if(cfg->logfile && cfg->logfile[0]) {
371 char* ad = fname_after_chroot(cfg->logfile, cfg, 1);
372 char* bd = basedir(ad);
373 if(bd && !is_dir(bd))
374 fatal_exit("logfile directory does not exist");
379 check_chroot_filelist("file with root-hints",
380 cfg->root_hints, cfg->chrootdir, cfg);
381 check_chroot_filelist("trust-anchor-file",
382 cfg->trust_anchor_file_list, cfg->chrootdir, cfg);
383 check_chroot_filelist("auto-trust-anchor-file",
384 cfg->auto_trust_anchor_file_list, cfg->chrootdir, cfg);
385 check_chroot_filelist_wild("trusted-keys-file",
386 cfg->trusted_keys_file_list, cfg->chrootdir, cfg);
387 check_chroot_string("dlv-anchor-file", &cfg->dlv_anchor_file,
388 cfg->chrootdir, cfg);
389 /* remove chroot setting so that modules are not stripping pathnames*/
390 free(cfg->chrootdir);
391 cfg->chrootdir = NULL;
393 if(strcmp(cfg->module_conf, "iterator") != 0
394 && strcmp(cfg->module_conf, "validator iterator") != 0
395 #ifdef WITH_PYTHONMODULE
396 && strcmp(cfg->module_conf, "python iterator") != 0
397 && strcmp(cfg->module_conf, "python validator iterator") != 0
398 && strcmp(cfg->module_conf, "validator python iterator") != 0
401 fatal_exit("module conf '%s' is not known to work",
406 if(cfg->username && cfg->username[0]) {
407 if(getpwnam(cfg->username) == NULL)
408 fatal_exit("user '%s' does not exist.", cfg->username);
412 if(cfg->remote_control_enable) {
413 check_chroot_string("server-key-file", &cfg->server_key_file,
414 cfg->chrootdir, cfg);
415 check_chroot_string("server-cert-file", &cfg->server_cert_file,
416 cfg->chrootdir, cfg);
417 if(!is_file(cfg->control_key_file))
418 fatal_exit("control-key-file: \"%s\" does not exist",
419 cfg->control_key_file);
420 if(!is_file(cfg->control_cert_file))
421 fatal_exit("control-cert-file: \"%s\" does not exist",
422 cfg->control_cert_file);
425 localzonechecks(cfg);
428 /** check forwards */
430 check_fwd(struct config_file* cfg)
432 struct iter_forwards* fwd = forwards_create();
433 if(!fwd || !forwards_apply_cfg(fwd, cfg)) {
434 fatal_exit("Could not set forward zones");
436 forwards_delete(fwd);
441 check_hints(struct config_file* cfg)
443 struct iter_hints* hints = hints_create();
444 if(!hints || !hints_apply_cfg(hints, cfg)) {
445 fatal_exit("Could not set root or stub hints");
450 /** check config file */
452 checkconf(const char* cfgfile, const char* opt)
454 struct config_file* cfg = config_create();
456 fatal_exit("out of memory");
457 if(!config_read(cfg, cfgfile, NULL)) {
458 /* config_read prints messages to stderr */
462 morechecks(cfg, cfgfile);
463 check_mod(cfg, iter_get_funcblock());
464 check_mod(cfg, val_get_funcblock());
465 #ifdef WITH_PYTHONMODULE
466 if(strstr(cfg->module_conf, "python"))
467 check_mod(cfg, pythonmod_get_funcblock());
471 if(opt) print_option(cfg, opt);
472 else printf("unbound-checkconf: no errors in %s\n", cfgfile);
476 /** getopt global, in case header files fail to declare it. */
478 /** getopt global, in case header files fail to declare it. */
481 /** Main routine for checkconf */
482 int main(int argc, char* argv[])
486 const char* opt = NULL;
487 const char* cfgfile = CONFIGFILE;
488 log_ident_set("unbound-checkconf");
489 log_init(NULL, 0, NULL);
492 /* use registry config file in preference to compiletime location */
493 if(!(cfgfile=w_lookup_reg_str("Software\\Unbound", "ConfigFile")))
494 cfgfile = CONFIGFILE;
495 #endif /* USE_WINSOCK */
496 /* parse the options */
497 while( (c=getopt(argc, argv, "ho:")) != -1) {
510 if(argc != 0 && argc != 1)