diff options
Diffstat (limited to 'contrib/unbound/smallapp/unbound-checkconf.c')
| -rw-r--r-- | contrib/unbound/smallapp/unbound-checkconf.c | 518 |
1 files changed, 518 insertions, 0 deletions
diff --git a/contrib/unbound/smallapp/unbound-checkconf.c b/contrib/unbound/smallapp/unbound-checkconf.c new file mode 100644 index 0000000..78733ed --- /dev/null +++ b/contrib/unbound/smallapp/unbound-checkconf.c @@ -0,0 +1,518 @@ +/* + * checkconf/unbound-checkconf.c - config file checker for unbound.conf file. + * + * Copyright (c) 2007, NLnet Labs. All rights reserved. + * + * This software is open source. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * Neither the name of the NLNET LABS nor the names of its contributors may + * be used to endorse or promote products derived from this software without + * specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED + * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** + * \file + * + * The config checker checks for syntax and other errors in the unbound.conf + * file, and can be used to check for errors before the server is started + * or sigHUPped. + * Exit status 1 means an error. + */ + +#include "config.h" +#include "util/log.h" +#include "util/config_file.h" +#include "util/module.h" +#include "util/net_help.h" +#include "util/regional.h" +#include "iterator/iterator.h" +#include "iterator/iter_fwd.h" +#include "iterator/iter_hints.h" +#include "validator/validator.h" +#include "services/localzone.h" +#include "ldns/sbuffer.h" +#ifdef HAVE_GETOPT_H +#include <getopt.h> +#endif +#ifdef HAVE_PWD_H +#include <pwd.h> +#endif +#ifdef HAVE_SYS_STAT_H +#include <sys/stat.h> +#endif +#ifdef HAVE_GLOB_H +#include <glob.h> +#endif +#ifdef WITH_PYTHONMODULE +#include "pythonmod/pythonmod.h" +#endif + +/** Give checkconf usage, and exit (1). */ +static void +usage() +{ + printf("Usage: unbound-checkconf [file]\n"); + printf(" Checks unbound configuration file for errors.\n"); + printf("file if omitted %s is used.\n", CONFIGFILE); + printf("-o option print value of option to stdout.\n"); + printf("-h show this usage help.\n"); + printf("Version %s\n", PACKAGE_VERSION); + printf("BSD licensed, see LICENSE in source package for details.\n"); + printf("Report bugs to %s\n", PACKAGE_BUGREPORT); + exit(1); +} + +/** + * Print given option to stdout + * @param cfg: config + * @param opt: option name without trailing :. + * This is different from config_set_option. + */ +static void +print_option(struct config_file* cfg, const char* opt) +{ + if(!config_get_option(cfg, opt, config_print_func, stdout)) + fatal_exit("cannot print option '%s'", opt); +} + +/** check if module works with config */ +static void +check_mod(struct config_file* cfg, struct module_func_block* fb) +{ + struct module_env env; + memset(&env, 0, sizeof(env)); + env.cfg = cfg; + env.scratch = regional_create(); + env.scratch_buffer = sldns_buffer_new(BUFSIZ); + if(!env.scratch || !env.scratch_buffer) + fatal_exit("out of memory"); + if(!(*fb->init)(&env, 0)) { + fatal_exit("bad config for %s module", fb->name); + } + (*fb->deinit)(&env, 0); + sldns_buffer_free(env.scratch_buffer); + regional_destroy(env.scratch); +} + +/** check localzones */ +static void +localzonechecks(struct config_file* cfg) +{ + struct local_zones* zs; + if(!(zs = local_zones_create())) + fatal_exit("out of memory"); + if(!local_zones_apply_cfg(zs, cfg)) + fatal_exit("failed local-zone, local-data configuration"); + local_zones_delete(zs); +} + +/** emit warnings for IP in hosts */ +static void +warn_hosts(const char* typ, struct config_stub* list) +{ + struct sockaddr_storage a; + socklen_t alen; + struct config_stub* s; + struct config_strlist* h; + for(s=list; s; s=s->next) { + for(h=s->hosts; h; h=h->next) { + if(extstrtoaddr(h->str, &a, &alen)) { + fprintf(stderr, "unbound-checkconf: warning:" + " %s %s: \"%s\" is an IP%s address, " + "and when looked up as a host name " + "during use may not resolve.\n", + s->name, typ, h->str, + addr_is_ip6(&a, alen)?"6":"4"); + } + } + } +} + +/** check interface strings */ +static void +interfacechecks(struct config_file* cfg) +{ + struct sockaddr_storage a; + socklen_t alen; + int i, j; + for(i=0; i<cfg->num_ifs; i++) { + if(!extstrtoaddr(cfg->ifs[i], &a, &alen)) { + fatal_exit("cannot parse interface specified as '%s'", + cfg->ifs[i]); + } + for(j=0; j<cfg->num_ifs; j++) { + if(i!=j && strcmp(cfg->ifs[i], cfg->ifs[j])==0) + fatal_exit("interface: %s present twice, " + "cannot bind same ports twice.", + cfg->ifs[i]); + } + } + for(i=0; i<cfg->num_out_ifs; i++) { + if(!ipstrtoaddr(cfg->out_ifs[i], UNBOUND_DNS_PORT, + &a, &alen)) { + fatal_exit("cannot parse outgoing-interface " + "specified as '%s'", cfg->out_ifs[i]); + } + for(j=0; j<cfg->num_out_ifs; j++) { + if(i!=j && strcmp(cfg->out_ifs[i], cfg->out_ifs[j])==0) + fatal_exit("outgoing-interface: %s present " + "twice, cannot bind same ports twice.", + cfg->out_ifs[i]); + } + } +} + +/** check acl ips */ +static void +aclchecks(struct config_file* cfg) +{ + int d; + struct sockaddr_storage a; + socklen_t alen; + struct config_str2list* acl; + for(acl=cfg->acls; acl; acl = acl->next) { + if(!netblockstrtoaddr(acl->str, UNBOUND_DNS_PORT, &a, &alen, + &d)) { + fatal_exit("cannot parse access control address %s %s", + acl->str, acl->str2); + } + } +} + +/** true if fname is a file */ +static int +is_file(const char* fname) +{ + struct stat buf; + if(stat(fname, &buf) < 0) { + if(errno==EACCES) { + printf("warning: no search permission for one of the directories in path: %s\n", fname); + return 1; + } + perror(fname); + return 0; + } + if(S_ISDIR(buf.st_mode)) { + printf("%s is not a file\n", fname); + return 0; + } + return 1; +} + +/** true if fname is a directory */ +static int +is_dir(const char* fname) +{ + struct stat buf; + if(stat(fname, &buf) < 0) { + if(errno==EACCES) { + printf("warning: no search permission for one of the directories in path: %s\n", fname); + return 1; + } + perror(fname); + return 0; + } + if(!(S_ISDIR(buf.st_mode))) { + printf("%s is not a directory\n", fname); + return 0; + } + return 1; +} + +/** get base dir of a fname */ +static char* +basedir(char* fname) +{ + char* rev; + if(!fname) fatal_exit("out of memory"); + rev = strrchr(fname, '/'); + if(!rev) return NULL; + if(fname == rev) return NULL; + rev[0] = 0; + return fname; +} + +/** check chroot for a file string */ +static void +check_chroot_string(const char* desc, char** ss, + const char* chrootdir, struct config_file* cfg) +{ + char* str = *ss; + if(str && str[0]) { + *ss = fname_after_chroot(str, cfg, 1); + if(!*ss) fatal_exit("out of memory"); + if(!is_file(*ss)) { + if(chrootdir && chrootdir[0]) + fatal_exit("%s: \"%s\" does not exist in " + "chrootdir %s", desc, str, chrootdir); + else + fatal_exit("%s: \"%s\" does not exist", + desc, str); + } + /* put in a new full path for continued checking */ + free(str); + } +} + +/** check file list, every file must be inside the chroot location */ +static void +check_chroot_filelist(const char* desc, struct config_strlist* list, + const char* chrootdir, struct config_file* cfg) +{ + struct config_strlist* p; + for(p=list; p; p=p->next) { + check_chroot_string(desc, &p->str, chrootdir, cfg); + } +} + +/** check file list, with wildcard processing */ +static void +check_chroot_filelist_wild(const char* desc, struct config_strlist* list, + const char* chrootdir, struct config_file* cfg) +{ + struct config_strlist* p; + for(p=list; p; p=p->next) { +#ifdef HAVE_GLOB + if(strchr(p->str, '*') || strchr(p->str, '[') || + strchr(p->str, '?') || strchr(p->str, '{') || + strchr(p->str, '~')) { + char* s = p->str; + /* adjust whole pattern for chroot and check later */ + p->str = fname_after_chroot(p->str, cfg, 1); + free(s); + } else +#endif /* HAVE_GLOB */ + check_chroot_string(desc, &p->str, chrootdir, cfg); + } +} + +/** check configuration for errors */ +static void +morechecks(struct config_file* cfg, const char* fname) +{ + warn_hosts("stub-host", cfg->stubs); + warn_hosts("forward-host", cfg->forwards); + interfacechecks(cfg); + aclchecks(cfg); + + if(cfg->verbosity < 0) + fatal_exit("verbosity value < 0"); + if(cfg->num_threads <= 0 || cfg->num_threads > 10000) + fatal_exit("num_threads value weird"); + if(!cfg->do_ip4 && !cfg->do_ip6) + fatal_exit("ip4 and ip6 are both disabled, pointless"); + if(!cfg->do_udp && !cfg->do_tcp) + fatal_exit("udp and tcp are both disabled, pointless"); + if(cfg->edns_buffer_size > cfg->msg_buffer_size) + fatal_exit("edns-buffer-size larger than msg-buffer-size, " + "answers will not fit in processing buffer"); + + if(cfg->chrootdir && cfg->chrootdir[0] && + cfg->chrootdir[strlen(cfg->chrootdir)-1] == '/') + fatal_exit("chootdir %s has trailing slash '/' please remove.", + cfg->chrootdir); + if(cfg->chrootdir && cfg->chrootdir[0] && + !is_dir(cfg->chrootdir)) { + fatal_exit("bad chroot directory"); + } + if(cfg->chrootdir && cfg->chrootdir[0]) { + char buf[10240]; + buf[0] = 0; + if(fname[0] != '/') { + if(getcwd(buf, sizeof(buf)) == NULL) + fatal_exit("getcwd: %s", strerror(errno)); + (void)strlcat(buf, "/", sizeof(buf)); + } + (void)strlcat(buf, fname, sizeof(buf)); + if(strncmp(buf, cfg->chrootdir, strlen(cfg->chrootdir)) != 0) + fatal_exit("config file %s is not inside chroot %s", + buf, cfg->chrootdir); + } + if(cfg->directory && cfg->directory[0]) { + char* ad = fname_after_chroot(cfg->directory, cfg, 0); + if(!ad) fatal_exit("out of memory"); + if(!is_dir(ad)) fatal_exit("bad chdir directory"); + free(ad); + } + if( (cfg->chrootdir && cfg->chrootdir[0]) || + (cfg->directory && cfg->directory[0])) { + if(cfg->pidfile && cfg->pidfile[0]) { + char* ad = (cfg->pidfile[0]=='/')?strdup(cfg->pidfile): + fname_after_chroot(cfg->pidfile, cfg, 1); + char* bd = basedir(ad); + if(bd && !is_dir(bd)) + fatal_exit("pidfile directory does not exist"); + free(ad); + } + if(cfg->logfile && cfg->logfile[0]) { + char* ad = fname_after_chroot(cfg->logfile, cfg, 1); + char* bd = basedir(ad); + if(bd && !is_dir(bd)) + fatal_exit("logfile directory does not exist"); + free(ad); + } + } + + check_chroot_filelist("file with root-hints", + cfg->root_hints, cfg->chrootdir, cfg); + check_chroot_filelist("trust-anchor-file", + cfg->trust_anchor_file_list, cfg->chrootdir, cfg); + check_chroot_filelist("auto-trust-anchor-file", + cfg->auto_trust_anchor_file_list, cfg->chrootdir, cfg); + check_chroot_filelist_wild("trusted-keys-file", + cfg->trusted_keys_file_list, cfg->chrootdir, cfg); + check_chroot_string("dlv-anchor-file", &cfg->dlv_anchor_file, + cfg->chrootdir, cfg); + /* remove chroot setting so that modules are not stripping pathnames*/ + free(cfg->chrootdir); + cfg->chrootdir = NULL; + + if(strcmp(cfg->module_conf, "iterator") != 0 + && strcmp(cfg->module_conf, "validator iterator") != 0 +#ifdef WITH_PYTHONMODULE + && strcmp(cfg->module_conf, "python iterator") != 0 + && strcmp(cfg->module_conf, "python validator iterator") != 0 + && strcmp(cfg->module_conf, "validator python iterator") != 0 +#endif + ) { + fatal_exit("module conf '%s' is not known to work", + cfg->module_conf); + } + +#ifdef HAVE_GETPWNAM + if(cfg->username && cfg->username[0]) { + if(getpwnam(cfg->username) == NULL) + fatal_exit("user '%s' does not exist.", cfg->username); + endpwent(); + } +#endif + if(cfg->remote_control_enable) { + check_chroot_string("server-key-file", &cfg->server_key_file, + cfg->chrootdir, cfg); + check_chroot_string("server-cert-file", &cfg->server_cert_file, + cfg->chrootdir, cfg); + if(!is_file(cfg->control_key_file)) + fatal_exit("control-key-file: \"%s\" does not exist", + cfg->control_key_file); + if(!is_file(cfg->control_cert_file)) + fatal_exit("control-cert-file: \"%s\" does not exist", + cfg->control_cert_file); + } + + localzonechecks(cfg); +} + +/** check forwards */ +static void +check_fwd(struct config_file* cfg) +{ + struct iter_forwards* fwd = forwards_create(); + if(!fwd || !forwards_apply_cfg(fwd, cfg)) { + fatal_exit("Could not set forward zones"); + } + forwards_delete(fwd); +} + +/** check hints */ +static void +check_hints(struct config_file* cfg) +{ + struct iter_hints* hints = hints_create(); + if(!hints || !hints_apply_cfg(hints, cfg)) { + fatal_exit("Could not set root or stub hints"); + } + hints_delete(hints); +} + +/** check config file */ +static void +checkconf(const char* cfgfile, const char* opt) +{ + struct config_file* cfg = config_create(); + if(!cfg) + fatal_exit("out of memory"); + if(!config_read(cfg, cfgfile, NULL)) { + /* config_read prints messages to stderr */ + config_delete(cfg); + exit(1); + } + morechecks(cfg, cfgfile); + check_mod(cfg, iter_get_funcblock()); + check_mod(cfg, val_get_funcblock()); +#ifdef WITH_PYTHONMODULE + if(strstr(cfg->module_conf, "python")) + check_mod(cfg, pythonmod_get_funcblock()); +#endif + check_fwd(cfg); + check_hints(cfg); + if(opt) print_option(cfg, opt); + else printf("unbound-checkconf: no errors in %s\n", cfgfile); + config_delete(cfg); +} + +/** getopt global, in case header files fail to declare it. */ +extern int optind; +/** getopt global, in case header files fail to declare it. */ +extern char* optarg; + +/** Main routine for checkconf */ +int main(int argc, char* argv[]) +{ + int c; + const char* f; + const char* opt = NULL; + const char* cfgfile = CONFIGFILE; + log_ident_set("unbound-checkconf"); + log_init(NULL, 0, NULL); + checklock_start(); +#ifdef USE_WINSOCK + /* use registry config file in preference to compiletime location */ + if(!(cfgfile=w_lookup_reg_str("Software\\Unbound", "ConfigFile"))) + cfgfile = CONFIGFILE; +#endif /* USE_WINSOCK */ + /* parse the options */ + while( (c=getopt(argc, argv, "ho:")) != -1) { + switch(c) { + case 'o': + opt = optarg; + break; + case '?': + case 'h': + default: + usage(); + } + } + argc -= optind; + argv += optind; + if(argc != 0 && argc != 1) + usage(); + if(argc == 1) + f = argv[0]; + else f = cfgfile; + checkconf(f, opt); + checklock_stop(); + return 0; +} |
