xref: /freebsd/contrib/unbound/smallapp/unbound-checkconf.c (revision c5c02a131a0e2ef52771e683269bc8778fe511f3)
1 /*
2  * smallapp/unbound-checkconf.c - config file checker for unbound.conf file.
3  *
4  * Copyright (c) 2007, NLnet Labs. All rights reserved.
5  *
6  * This software is open source.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
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.
18  *
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.
22  *
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.
34  */
35 
36 /**
37  * \file
38  *
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
41  * or sigHUPped.
42  * Exit status 1 means an error.
43  */
44 
45 #include "config.h"
46 #include <ctype.h>
47 #include "util/log.h"
48 #include "util/config_file.h"
49 #include "util/module.h"
50 #include "util/net_help.h"
51 #include "util/regional.h"
52 #include "iterator/iterator.h"
53 #include "iterator/iter_fwd.h"
54 #include "iterator/iter_hints.h"
55 #include "validator/validator.h"
56 #include "services/localzone.h"
57 #include "services/listen_dnsport.h"
58 #include "services/view.h"
59 #include "services/authzone.h"
60 #include "respip/respip.h"
61 #include "sldns/sbuffer.h"
62 #include "sldns/str2wire.h"
63 #ifdef HAVE_GETOPT_H
64 #include <getopt.h>
65 #endif
66 #ifdef HAVE_PWD_H
67 #include <pwd.h>
68 #endif
69 #ifdef HAVE_SYS_STAT_H
70 #include <sys/stat.h>
71 #endif
72 #ifdef HAVE_GLOB_H
73 #include <glob.h>
74 #endif
75 #ifdef WITH_PYTHONMODULE
76 #include "pythonmod/pythonmod.h"
77 #endif
78 #ifdef CLIENT_SUBNET
79 #include "edns-subnet/subnet-whitelist.h"
80 #endif
81 
82 /** Give checkconf usage, and exit (1). */
83 static void
84 usage(void)
85 {
86 	printf("Usage:	local-unbound-checkconf [file]\n");
87 	printf("	Checks unbound configuration file for errors.\n");
88 	printf("file	if omitted %s is used.\n", CONFIGFILE);
89 	printf("-o option	print value of option to stdout.\n");
90 	printf("-f 		output full pathname with chroot applied, eg. with -o pidfile.\n");
91 	printf("-q 		quiet (suppress output on success).\n");
92 	printf("-h		show this usage help.\n");
93 	printf("Version %s\n", PACKAGE_VERSION);
94 	printf("BSD licensed, see LICENSE in source package for details.\n");
95 	printf("Report bugs to %s\n", PACKAGE_BUGREPORT);
96 	exit(1);
97 }
98 
99 /**
100  * Print given option to stdout
101  * @param cfg: config
102  * @param opt: option name without trailing :.
103  *	This is different from config_set_option.
104  * @param final: if final pathname with chroot applied has to be printed.
105  */
106 static void
107 print_option(struct config_file* cfg, const char* opt, int final)
108 {
109 	if(strcmp(opt, "pidfile") == 0 && final) {
110 		char *p = fname_after_chroot(cfg->pidfile, cfg, 1);
111 		if(!p) fatal_exit("out of memory");
112 		printf("%s\n", p);
113 		free(p);
114 		return;
115 	}
116 	if(strcmp(opt, "auto-trust-anchor-file") == 0 && final) {
117 		struct config_strlist* s = cfg->auto_trust_anchor_file_list;
118 		for(; s; s=s->next) {
119 			char *p = fname_after_chroot(s->str, cfg, 1);
120 			if(!p) fatal_exit("out of memory");
121 			printf("%s\n", p);
122 			free(p);
123 		}
124 		return;
125 	}
126 	if(!config_get_option(cfg, opt, config_print_func, stdout))
127 		fatal_exit("cannot print option '%s'", opt);
128 }
129 
130 /** check if module works with config */
131 static void
132 check_mod(struct config_file* cfg, struct module_func_block* fb)
133 {
134 	struct module_env env;
135 	memset(&env, 0, sizeof(env));
136 	env.cfg = cfg;
137 	env.scratch = regional_create();
138 	env.scratch_buffer = sldns_buffer_new(BUFSIZ);
139 	if(!env.scratch || !env.scratch_buffer)
140 		fatal_exit("out of memory");
141 	if(!edns_known_options_init(&env))
142 		fatal_exit("out of memory");
143 	if(fb->startup && !(*fb->startup)(&env, 0))
144 		fatal_exit("bad config during startup for %s module", fb->name);
145 	if(!(*fb->init)(&env, 0))
146 		fatal_exit("bad config during init for %s module", fb->name);
147 	(*fb->deinit)(&env, 0);
148 	if(fb->destartup)
149 		(*fb->destartup)(&env, 0);
150 	sldns_buffer_free(env.scratch_buffer);
151 	regional_destroy(env.scratch);
152 	edns_known_options_delete(&env);
153 }
154 
155 /** true if addr is a localhost address, 127.0.0.1 or ::1 (with maybe "@port"
156  * after it) */
157 static int
158 str_addr_is_localhost(const char* a)
159 {
160 	if(strncmp(a, "127.", 4) == 0) return 1;
161 	if(strncmp(a, "::1", 3) == 0) return 1;
162 	return 0;
163 }
164 
165 /** check do-not-query-localhost */
166 static void
167 donotquerylocalhostcheck(struct config_file* cfg)
168 {
169 	if(cfg->donotquery_localhost) {
170 		struct config_stub* p;
171 		struct config_strlist* s;
172 		for(p=cfg->forwards; p; p=p->next) {
173 			for(s=p->addrs; s; s=s->next) {
174 				if(str_addr_is_localhost(s->str)) {
175 					fprintf(stderr, "unbound-checkconf: warning: forward-addr: '%s' is specified for forward-zone: '%s', but do-not-query-localhost: yes means that the address will not be used for lookups.\n",
176 						s->str, p->name);
177 				}
178 			}
179 		}
180 		for(p=cfg->stubs; p; p=p->next) {
181 			for(s=p->addrs; s; s=s->next) {
182 				if(str_addr_is_localhost(s->str)) {
183 					fprintf(stderr, "unbound-checkconf: warning: stub-addr: '%s' is specified for stub-zone: '%s', but do-not-query-localhost: yes means that the address will not be used for lookups.\n",
184 						s->str, p->name);
185 				}
186 			}
187 		}
188 	}
189 }
190 
191 /** check localzones */
192 static void
193 localzonechecks(struct config_file* cfg)
194 {
195 	struct local_zones* zs;
196 	if(!(zs = local_zones_create()))
197 		fatal_exit("out of memory");
198 	if(!local_zones_apply_cfg(zs, cfg))
199 		fatal_exit("failed local-zone, local-data configuration");
200 	local_zones_delete(zs);
201 }
202 
203 /** checks for acl and views */
204 static void
205 acl_view_tag_checks(struct config_file* cfg, struct views* views)
206 {
207 	int d;
208 	struct sockaddr_storage a;
209 	socklen_t alen;
210 	struct config_str2list* acl;
211 	struct config_str3list* s3;
212 	struct config_strbytelist* sb;
213 
214 	/* acl_view */
215 	for(acl=cfg->acl_view; acl; acl = acl->next) {
216 		struct view* v;
217 		if(!netblockstrtoaddr(acl->str, UNBOUND_DNS_PORT, &a, &alen,
218 			&d)) {
219 			fatal_exit("cannot parse access-control-view "
220 				"address %s %s", acl->str, acl->str2);
221 		}
222 		v = views_find_view(views, acl->str2, 0);
223 		if(!v) {
224 			fatal_exit("cannot find view for "
225 				"access-control-view: %s %s",
226 				acl->str, acl->str2);
227 		}
228 		lock_rw_unlock(&v->lock);
229 	}
230 
231 	/* acl_tags */
232 	for(sb=cfg->acl_tags; sb; sb = sb->next) {
233 		if(!netblockstrtoaddr(sb->str, UNBOUND_DNS_PORT, &a, &alen,
234 			&d)) {
235 			fatal_exit("cannot parse access-control-tags "
236 				"address %s", sb->str);
237 		}
238 	}
239 
240 	/* acl_tag_actions */
241 	for(s3=cfg->acl_tag_actions; s3; s3 = s3->next) {
242 		enum localzone_type t;
243 		if(!netblockstrtoaddr(s3->str, UNBOUND_DNS_PORT, &a, &alen,
244 			&d)) {
245 			fatal_exit("cannot parse access-control-tag-actions "
246 				"address %s %s %s",
247 				s3->str, s3->str2, s3->str3);
248 		}
249 		if(find_tag_id(cfg, s3->str2) == -1) {
250 			fatal_exit("cannot parse tag %s (define-tag it), "
251 				"for access-control-tag-actions: %s %s %s",
252 				s3->str2, s3->str, s3->str2, s3->str3);
253 		}
254 		if(!local_zone_str2type(s3->str3, &t)) {
255 			fatal_exit("cannot parse access control action type %s"
256 				" for access-control-tag-actions: %s %s %s",
257 				s3->str3, s3->str, s3->str2, s3->str3);
258 		}
259 	}
260 
261 	/* acl_tag_datas */
262 	for(s3=cfg->acl_tag_datas; s3; s3 = s3->next) {
263 		char buf[65536];
264 		uint8_t rr[LDNS_RR_BUF_SIZE];
265 		size_t len = sizeof(rr);
266 		int res;
267 		if(!netblockstrtoaddr(s3->str, UNBOUND_DNS_PORT, &a, &alen,
268 			&d)) {
269 			fatal_exit("cannot parse access-control-tag-datas address %s %s '%s'",
270 				s3->str, s3->str2, s3->str3);
271 		}
272 		if(find_tag_id(cfg, s3->str2) == -1) {
273 			fatal_exit("cannot parse tag %s (define-tag it), "
274 				"for access-control-tag-datas: %s %s '%s'",
275 				s3->str2, s3->str, s3->str2, s3->str3);
276 		}
277 		/* '.' is sufficient for validation, and it makes the call to
278 		 * sldns_wirerr_get_type() simpler below. */
279 		snprintf(buf, sizeof(buf), "%s %s", ".", s3->str3);
280 		res = sldns_str2wire_rr_buf(buf, rr, &len, NULL, 3600, NULL,
281 			0, NULL, 0);
282 		if(res != 0) {
283 			fatal_exit("cannot parse rr data [char %d] parse error %s, for access-control-tag-datas: %s %s '%s'",
284 				(int)LDNS_WIREPARSE_OFFSET(res)-2,
285 				sldns_get_errorstr_parse(res),
286 				s3->str, s3->str2, s3->str3);
287 		}
288 	}
289 }
290 
291 /** check view and response-ip configuration */
292 static void
293 view_and_respipchecks(struct config_file* cfg)
294 {
295 	struct views* views = NULL;
296 	struct respip_set* respip = NULL;
297 	int ignored = 0;
298 	if(!(views = views_create()))
299 		fatal_exit("Could not create views: out of memory");
300 	if(!(respip = respip_set_create()))
301 		fatal_exit("Could not create respip set: out of memory");
302 	if(!views_apply_cfg(views, cfg))
303 		fatal_exit("Could not set up views");
304 	if(!respip_global_apply_cfg(respip, cfg))
305 		fatal_exit("Could not setup respip set");
306 	if(!respip_views_apply_cfg(views, cfg, &ignored))
307 		fatal_exit("Could not setup per-view respip sets");
308 	acl_view_tag_checks(cfg, views);
309 	views_delete(views);
310 	respip_set_delete(respip);
311 }
312 
313 /** emit warnings for IP in hosts */
314 static void
315 warn_hosts(const char* typ, struct config_stub* list)
316 {
317 	struct sockaddr_storage a;
318 	socklen_t alen;
319 	struct config_stub* s;
320 	struct config_strlist* h;
321 	for(s=list; s; s=s->next) {
322 		for(h=s->hosts; h; h=h->next) {
323 			if(extstrtoaddr(h->str, &a, &alen, UNBOUND_DNS_PORT)) {
324 				fprintf(stderr, "unbound-checkconf: warning:"
325 				  " %s %s: \"%s\" is an IP%s address, "
326 				  "and when looked up as a host name "
327 				  "during use may not resolve.\n",
328 				  s->name, typ, h->str,
329 				  addr_is_ip6(&a, alen)?"6":"4");
330 			}
331 		}
332 	}
333 }
334 
335 /** check interface strings */
336 static void
337 interfacechecks(struct config_file* cfg)
338 {
339 	int d;
340 	struct sockaddr_storage a;
341 	socklen_t alen;
342 	int i, j, i2, j2;
343 	char*** resif = NULL;
344 	int* num_resif = NULL;
345 	char portbuf[32];
346 	snprintf(portbuf, sizeof(portbuf), "%d", cfg->port);
347 
348 	if(cfg->num_ifs != 0) {
349 		resif = (char***)calloc(cfg->num_ifs, sizeof(char**));
350 		if(!resif) fatal_exit("malloc failure");
351 		num_resif = (int*)calloc(cfg->num_ifs, sizeof(int));
352 		if(!num_resif) fatal_exit("malloc failure");
353 	}
354 	for(i=0; i<cfg->num_ifs; i++) {
355 		/* search for duplicates in IP or ifname arguments */
356 		for(i2=0; i2<i; i2++) {
357 			if(strcmp(cfg->ifs[i], cfg->ifs[i2]) == 0) {
358 				fatal_exit("interface: %s present twice, "
359 					"cannot bind same ports twice.",
360 					cfg->ifs[i]);
361 			}
362 		}
363 		if(!resolve_interface_names(&cfg->ifs[i], 1, NULL, &resif[i],
364 			&num_resif[i])) {
365 			fatal_exit("could not resolve interface names, for %s",
366 				cfg->ifs[i]);
367 		}
368 		/* check for port combinations that are not supported */
369 		if(if_is_pp2(resif[i][0], portbuf, cfg->proxy_protocol_port)) {
370 			if(if_is_dnscrypt(resif[i][0], portbuf,
371 				cfg->dnscrypt_port)) {
372 				fatal_exit("PROXYv2 and DNSCrypt combination not "
373 					"supported!");
374 			} else if(if_is_https(resif[i][0], portbuf,
375 				cfg->https_port)) {
376 				fatal_exit("PROXYv2 and DoH combination not "
377 					"supported!");
378 			}
379 		}
380 		/* search for duplicates in the returned addresses */
381 		for(j=0; j<num_resif[i]; j++) {
382 			if(!extstrtoaddr(resif[i][j], &a, &alen, cfg->port)) {
383 				if(strcmp(cfg->ifs[i], resif[i][j]) != 0)
384 					fatal_exit("cannot parse interface address '%s' from the interface specified as '%s'",
385 						resif[i][j], cfg->ifs[i]);
386 				else
387 					fatal_exit("cannot parse interface specified as '%s'",
388 						cfg->ifs[i]);
389 			}
390 			for(i2=0; i2<i; i2++) {
391 				for(j2=0; j2<num_resif[i2]; j2++) {
392 					if(strcmp(resif[i][j], resif[i2][j2])
393 						== 0) {
394 						char info1[1024], info2[1024];
395 						if(strcmp(cfg->ifs[i], resif[i][j]) != 0)
396 							snprintf(info1, sizeof(info1), "address %s from interface: %s", resif[i][j], cfg->ifs[i]);
397 						else	snprintf(info1, sizeof(info1), "interface: %s", cfg->ifs[i]);
398 						if(strcmp(cfg->ifs[i2], resif[i2][j2]) != 0)
399 							snprintf(info2, sizeof(info2), "address %s from interface: %s", resif[i2][j2], cfg->ifs[i2]);
400 						else	snprintf(info2, sizeof(info2), "interface: %s", cfg->ifs[i2]);
401 						fatal_exit("%s present twice, cannot bind the same ports twice. The first entry is %s and the second is %s", resif[i][j], info2, info1);
402 					}
403 				}
404 			}
405 		}
406 	}
407 
408 	for(i=0; i<cfg->num_ifs; i++) {
409 		config_del_strarray(resif[i], num_resif[i]);
410 	}
411 	free(resif);
412 	free(num_resif);
413 
414 	for(i=0; i<cfg->num_out_ifs; i++) {
415 		if(!ipstrtoaddr(cfg->out_ifs[i], UNBOUND_DNS_PORT, &a, &alen) &&
416 		   !netblockstrtoaddr(cfg->out_ifs[i], UNBOUND_DNS_PORT, &a, &alen, &d)) {
417 			fatal_exit("cannot parse outgoing-interface "
418 				"specified as '%s'", cfg->out_ifs[i]);
419 		}
420 		for(j=0; j<cfg->num_out_ifs; j++) {
421 			if(i!=j && strcmp(cfg->out_ifs[i], cfg->out_ifs[j])==0)
422 				fatal_exit("outgoing-interface: %s present "
423 					"twice, cannot bind same ports twice.",
424 					cfg->out_ifs[i]);
425 		}
426 	}
427 }
428 
429 /** check interface-automatic-ports */
430 static void
431 ifautomaticportschecks(char* ifautomaticports)
432 {
433 	char* now = ifautomaticports;
434 	while(now && *now) {
435 		char* after;
436 		int extraport;
437 		while(isspace((unsigned char)*now))
438 			now++;
439 		if(!*now)
440 			break;
441 		after = now;
442 		extraport = (int)strtol(now, &after, 10);
443 		if(extraport < 0 || extraport > 65535)
444 			fatal_exit("interface-automatic-ports: port out of range at position %d in '%s'", (int)(now-ifautomaticports)+1, ifautomaticports);
445 		if(extraport == 0 && now == after)
446 			fatal_exit("interface-automatic-ports: parse error at position %d in '%s'", (int)(now-ifautomaticports)+1, ifautomaticports);
447 		now = after;
448 	}
449 }
450 
451 /** check acl ips */
452 static void
453 aclchecks(struct config_file* cfg)
454 {
455 	int d;
456 	struct sockaddr_storage a;
457 	socklen_t alen;
458 	struct config_str2list* acl;
459 	for(acl=cfg->acls; acl; acl = acl->next) {
460 		if(!netblockstrtoaddr(acl->str, UNBOUND_DNS_PORT, &a, &alen,
461 			&d)) {
462 			fatal_exit("cannot parse access control address %s %s",
463 				acl->str, acl->str2);
464 		}
465 	}
466 }
467 
468 /** check tcp connection limit ips */
469 static void
470 tcpconnlimitchecks(struct config_file* cfg)
471 {
472 	int d;
473 	struct sockaddr_storage a;
474 	socklen_t alen;
475 	struct config_str2list* tcl;
476 	for(tcl=cfg->tcp_connection_limits; tcl; tcl = tcl->next) {
477 		if(!netblockstrtoaddr(tcl->str, UNBOUND_DNS_PORT, &a, &alen,
478 			&d)) {
479 			fatal_exit("cannot parse tcp connection limit address %s %s",
480 				tcl->str, tcl->str2);
481 		}
482 	}
483 }
484 
485 /** true if fname is a file */
486 static int
487 is_file(const char* fname)
488 {
489 	struct stat buf;
490 	if(stat(fname, &buf) < 0) {
491 		if(errno==EACCES) {
492 			printf("warning: no search permission for one of the directories in path: %s\n", fname);
493 			return 1;
494 		}
495 		perror(fname);
496 		return 0;
497 	}
498 	if(S_ISDIR(buf.st_mode)) {
499 		printf("%s is not a file\n", fname);
500 		return 0;
501 	}
502 	return 1;
503 }
504 
505 /** true if fname is a directory */
506 static int
507 is_dir(const char* fname)
508 {
509 	struct stat buf;
510 	if(stat(fname, &buf) < 0) {
511 		if(errno==EACCES) {
512 			printf("warning: no search permission for one of the directories in path: %s\n", fname);
513 			return 1;
514 		}
515 		perror(fname);
516 		return 0;
517 	}
518 	if(!(S_ISDIR(buf.st_mode))) {
519 		printf("%s is not a directory\n", fname);
520 		return 0;
521 	}
522 	return 1;
523 }
524 
525 /** get base dir of a fname */
526 static char*
527 basedir(char* fname)
528 {
529 	char* rev;
530 	if(!fname) fatal_exit("out of memory");
531 	rev = strrchr(fname, '/');
532 	if(!rev) return NULL;
533 	if(fname == rev) return NULL;
534 	rev[0] = 0;
535 	return fname;
536 }
537 
538 /** check chroot for a file string */
539 static void
540 check_chroot_string(const char* desc, char** ss,
541 	const char* chrootdir, struct config_file* cfg)
542 {
543 	char* str = *ss;
544 	if(str && str[0]) {
545 		*ss = fname_after_chroot(str, cfg, 1);
546 		if(!*ss) fatal_exit("out of memory");
547 		if(!is_file(*ss)) {
548 			if(chrootdir && chrootdir[0])
549 				fatal_exit("%s: \"%s\" does not exist in "
550 					"chrootdir %s", desc, str, chrootdir);
551 			else
552 				fatal_exit("%s: \"%s\" does not exist",
553 					desc, str);
554 		}
555 		/* put in a new full path for continued checking */
556 		free(str);
557 	}
558 }
559 
560 /** check file list, every file must be inside the chroot location */
561 static void
562 check_chroot_filelist(const char* desc, struct config_strlist* list,
563 	const char* chrootdir, struct config_file* cfg)
564 {
565 	struct config_strlist* p;
566 	for(p=list; p; p=p->next) {
567 		check_chroot_string(desc, &p->str, chrootdir, cfg);
568 	}
569 }
570 
571 /** check file list, with wildcard processing */
572 static void
573 check_chroot_filelist_wild(const char* desc, struct config_strlist* list,
574 	const char* chrootdir, struct config_file* cfg)
575 {
576 	struct config_strlist* p;
577 	for(p=list; p; p=p->next) {
578 #ifdef HAVE_GLOB
579 		if(strchr(p->str, '*') || strchr(p->str, '[') ||
580 			strchr(p->str, '?') || strchr(p->str, '{') ||
581 			strchr(p->str, '~')) {
582 			char* s = p->str;
583 			/* adjust whole pattern for chroot and check later */
584 			p->str = fname_after_chroot(p->str, cfg, 1);
585 			free(s);
586 		} else
587 #endif /* HAVE_GLOB */
588 			check_chroot_string(desc, &p->str, chrootdir, cfg);
589 	}
590 }
591 
592 #ifdef CLIENT_SUBNET
593 /** check ECS configuration */
594 static void
595 ecs_conf_checks(struct config_file* cfg)
596 {
597 	struct ecs_whitelist* whitelist = NULL;
598 	if(!(whitelist = ecs_whitelist_create()))
599 		fatal_exit("Could not create ednssubnet whitelist: out of memory");
600         if(!ecs_whitelist_apply_cfg(whitelist, cfg))
601 		fatal_exit("Could not setup ednssubnet whitelist");
602 	ecs_whitelist_delete(whitelist);
603 }
604 #endif /* CLIENT_SUBNET */
605 
606 /** check that the modules exist, are compiled in */
607 static void
608 check_modules_exist(const char* module_conf)
609 {
610 	const char** names = module_list_avail();
611 	const char* s = module_conf;
612 	while(*s) {
613 		int i = 0;
614 		int is_ok = 0;
615 		while(*s && isspace((unsigned char)*s))
616 			s++;
617 		if(!*s) break;
618 		while(names[i]) {
619 			if(strncmp(names[i], s, strlen(names[i])) == 0) {
620 				is_ok = 1;
621 				break;
622 			}
623 			i++;
624 		}
625 		if(is_ok == 0) {
626 			char n[64];
627 			size_t j;
628 			n[0]=0;
629 			n[sizeof(n)-1]=0;
630 			for(j=0; j<sizeof(n)-1; j++) {
631 				if(!s[j] || isspace((unsigned char)s[j])) {
632 					n[j] = 0;
633 					break;
634 				}
635 				n[j] = s[j];
636 			}
637 			fatal_exit("module_conf lists module '%s' but that "
638 				"module is not available.", n);
639 		}
640 		s += strlen(names[i]);
641 	}
642 }
643 
644 /** check configuration for errors */
645 static void
646 morechecks(struct config_file* cfg)
647 {
648 	warn_hosts("stub-host", cfg->stubs);
649 	warn_hosts("forward-host", cfg->forwards);
650 	interfacechecks(cfg);
651 	ifautomaticportschecks(cfg->if_automatic_ports);
652 	aclchecks(cfg);
653 	tcpconnlimitchecks(cfg);
654 
655 	if(cfg->verbosity < 0)
656 		fatal_exit("verbosity value < 0");
657 	if(cfg->num_threads <= 0 || cfg->num_threads > 10000)
658 		fatal_exit("num_threads value weird");
659 	if(!cfg->do_ip4 && !cfg->do_ip6)
660 		fatal_exit("ip4 and ip6 are both disabled, pointless");
661 	if(!cfg->do_ip4 && cfg->prefer_ip4)
662 		fatal_exit("cannot prefer and disable ip4, pointless");
663 	if(!cfg->do_ip6 && cfg->prefer_ip6)
664 		fatal_exit("cannot prefer and disable ip6, pointless");
665 	if(!cfg->do_udp && !cfg->do_tcp)
666 		fatal_exit("udp and tcp are both disabled, pointless");
667 	if(cfg->edns_buffer_size > cfg->msg_buffer_size)
668 		fatal_exit("edns-buffer-size larger than msg-buffer-size, "
669 			"answers will not fit in processing buffer");
670 #ifdef UB_ON_WINDOWS
671 	w_config_adjust_directory(cfg);
672 #endif
673 	if(cfg->chrootdir && cfg->chrootdir[0] &&
674 		cfg->chrootdir[strlen(cfg->chrootdir)-1] == '/')
675 		fatal_exit("chootdir %s has trailing slash '/' please remove.",
676 			cfg->chrootdir);
677 	if(cfg->chrootdir && cfg->chrootdir[0] &&
678 		!is_dir(cfg->chrootdir)) {
679 		fatal_exit("bad chroot directory");
680 	}
681 	if(cfg->directory && cfg->directory[0]) {
682 		char* ad = fname_after_chroot(cfg->directory, cfg, 0);
683 		if(!ad) fatal_exit("out of memory");
684 		if(!is_dir(ad)) fatal_exit("bad chdir directory");
685 		free(ad);
686 	}
687 	if( (cfg->chrootdir && cfg->chrootdir[0]) ||
688 	    (cfg->directory && cfg->directory[0])) {
689 		if(cfg->pidfile && cfg->pidfile[0]) {
690 			char* ad = (cfg->pidfile[0]=='/')?strdup(cfg->pidfile):
691 				fname_after_chroot(cfg->pidfile, cfg, 1);
692 			char* bd = basedir(ad);
693 			if(bd && !is_dir(bd))
694 				fatal_exit("pidfile directory does not exist");
695 			free(ad);
696 		}
697 		if(cfg->logfile && cfg->logfile[0]) {
698 			char* ad = fname_after_chroot(cfg->logfile, cfg, 1);
699 			char* bd = basedir(ad);
700 			if(bd && !is_dir(bd))
701 				fatal_exit("logfile directory does not exist");
702 			free(ad);
703 		}
704 	}
705 
706 	check_chroot_filelist("file with root-hints",
707 		cfg->root_hints, cfg->chrootdir, cfg);
708 	check_chroot_filelist("trust-anchor-file",
709 		cfg->trust_anchor_file_list, cfg->chrootdir, cfg);
710 	check_chroot_filelist("auto-trust-anchor-file",
711 		cfg->auto_trust_anchor_file_list, cfg->chrootdir, cfg);
712 	check_chroot_filelist_wild("trusted-keys-file",
713 		cfg->trusted_keys_file_list, cfg->chrootdir, cfg);
714 	if(cfg->disable_edns_do && strstr(cfg->module_conf, "validator")
715 		&& (cfg->trust_anchor_file_list
716 		|| cfg->trust_anchor_list
717 		|| cfg->auto_trust_anchor_file_list
718 		|| cfg->trusted_keys_file_list)) {
719 		char* key = NULL;
720 		if(cfg->auto_trust_anchor_file_list)
721 			key = cfg->auto_trust_anchor_file_list->str;
722 		if(!key && cfg->trust_anchor_file_list)
723 			key = cfg->trust_anchor_file_list->str;
724 		if(!key && cfg->trust_anchor_list)
725 			key = cfg->trust_anchor_list->str;
726 		if(!key && cfg->trusted_keys_file_list)
727 			key = cfg->trusted_keys_file_list->str;
728 		if(!key) key = "";
729 		fatal_exit("disable-edns-do does not allow DNSSEC to work, but the validator module uses a trust anchor %s, turn off disable-edns-do or disable validation", key);
730 	}
731 #ifdef USE_IPSECMOD
732 	if(cfg->ipsecmod_enabled && strstr(cfg->module_conf, "ipsecmod")) {
733 		/* only check hook if enabled */
734 		check_chroot_string("ipsecmod-hook", &cfg->ipsecmod_hook,
735 			cfg->chrootdir, cfg);
736 	}
737 #endif
738 	/* remove chroot setting so that modules are not stripping pathnames */
739 	free(cfg->chrootdir);
740 	cfg->chrootdir = NULL;
741 
742 	/* check that the modules listed in module_conf exist */
743 	check_modules_exist(cfg->module_conf);
744 
745 	/* Respip is known to *not* work with dns64. */
746 	if(strcmp(cfg->module_conf, "iterator") != 0
747 		&& strcmp(cfg->module_conf, "validator iterator") != 0
748 		&& strcmp(cfg->module_conf, "dns64 validator iterator") != 0
749 		&& strcmp(cfg->module_conf, "dns64 iterator") != 0
750 		&& strcmp(cfg->module_conf, "respip iterator") != 0
751 		&& strcmp(cfg->module_conf, "respip validator iterator") != 0
752 		&& strcmp(cfg->module_conf, "respip dns64 validator iterator") != 0
753 		&& strcmp(cfg->module_conf, "respip dns64 iterator") != 0
754 #ifdef WITH_PYTHONMODULE
755 		&& strcmp(cfg->module_conf, "python iterator") != 0
756 		&& strcmp(cfg->module_conf, "python respip iterator") != 0
757 		&& strcmp(cfg->module_conf, "python validator iterator") != 0
758 		&& strcmp(cfg->module_conf, "python respip validator iterator") != 0
759 		&& strcmp(cfg->module_conf, "validator python iterator") != 0
760 		&& strcmp(cfg->module_conf, "dns64 python iterator") != 0
761 		&& strcmp(cfg->module_conf, "dns64 python validator iterator") != 0
762 		&& strcmp(cfg->module_conf, "dns64 validator python iterator") != 0
763 		&& strcmp(cfg->module_conf, "python dns64 iterator") != 0
764 		&& strcmp(cfg->module_conf, "python dns64 validator iterator") != 0
765 #endif
766 #ifdef WITH_DYNLIBMODULE
767 		&& strcmp(cfg->module_conf, "dynlib iterator") != 0
768 		&& strcmp(cfg->module_conf, "dynlib dynlib iterator") != 0
769 		&& strcmp(cfg->module_conf, "dynlib dynlib dynlib iterator") != 0
770 		&& strcmp(cfg->module_conf, "python dynlib iterator") != 0
771 		&& strcmp(cfg->module_conf, "python dynlib dynlib iterator") != 0
772 		&& strcmp(cfg->module_conf, "python dynlib dynlib dynlib iterator") != 0
773 		&& strcmp(cfg->module_conf, "dynlib respip iterator") != 0
774 		&& strcmp(cfg->module_conf, "dynlib validator iterator") != 0
775 		&& strcmp(cfg->module_conf, "dynlib dynlib validator iterator") != 0
776 		&& strcmp(cfg->module_conf, "dynlib dynlib dynlib validator iterator") != 0
777 		&& strcmp(cfg->module_conf, "python dynlib validator iterator") != 0
778 		&& strcmp(cfg->module_conf, "python dynlib dynlib validator iterator") != 0
779 		&& strcmp(cfg->module_conf, "python dynlib dynlib dynlib validator iterator") != 0
780 		&& strcmp(cfg->module_conf, "dynlib respip validator iterator") != 0
781 		&& strcmp(cfg->module_conf, "validator dynlib iterator") != 0
782 		&& strcmp(cfg->module_conf, "dns64 dynlib iterator") != 0
783 		&& strcmp(cfg->module_conf, "dns64 dynlib validator iterator") != 0
784 		&& strcmp(cfg->module_conf, "dns64 validator dynlib iterator") != 0
785 		&& strcmp(cfg->module_conf, "dynlib dns64 iterator") != 0
786 		&& strcmp(cfg->module_conf, "dynlib dns64 validator iterator") != 0
787 		&& strcmp(cfg->module_conf, "dynlib dns64 cachedb iterator") != 0
788 		&& strcmp(cfg->module_conf, "dynlib dns64 validator cachedb iterator") != 0
789 		&& strcmp(cfg->module_conf, "dns64 dynlib cachedb iterator") != 0
790 		&& strcmp(cfg->module_conf, "dns64 dynlib validator cachedb iterator") != 0
791 		&& strcmp(cfg->module_conf, "dynlib cachedb iterator") != 0
792 		&& strcmp(cfg->module_conf, "dynlib respip cachedb iterator") != 0
793 		&& strcmp(cfg->module_conf, "dynlib validator cachedb iterator") != 0
794 		&& strcmp(cfg->module_conf, "dynlib respip validator cachedb iterator") != 0
795 		&& strcmp(cfg->module_conf, "cachedb dynlib iterator") != 0
796 		&& strcmp(cfg->module_conf, "respip cachedb dynlib iterator") != 0
797 		&& strcmp(cfg->module_conf, "validator cachedb dynlib iterator") != 0
798 		&& strcmp(cfg->module_conf, "respip validator cachedb dynlib iterator") != 0
799 		&& strcmp(cfg->module_conf, "validator dynlib cachedb iterator") != 0
800 		&& strcmp(cfg->module_conf, "respip validator dynlib cachedb iterator") != 0
801 		&& strcmp(cfg->module_conf, "dynlib subnetcache iterator") != 0
802 		&& strcmp(cfg->module_conf, "dynlib respip subnetcache iterator") != 0
803 		&& strcmp(cfg->module_conf, "subnetcache dynlib iterator") != 0
804 		&& strcmp(cfg->module_conf, "respip subnetcache dynlib iterator") != 0
805 		&& strcmp(cfg->module_conf, "dynlib subnetcache validator iterator") != 0
806 		&& strcmp(cfg->module_conf, "dynlib respip subnetcache validator iterator") != 0
807 		&& strcmp(cfg->module_conf, "subnetcache dynlib validator iterator") != 0
808 		&& strcmp(cfg->module_conf, "respip subnetcache dynlib validator iterator") != 0
809 		&& strcmp(cfg->module_conf, "subnetcache validator dynlib iterator") != 0
810 		&& strcmp(cfg->module_conf, "respip subnetcache validator dynlib iterator") != 0
811 		&& strcmp(cfg->module_conf, "dynlib ipsecmod iterator") != 0
812 		&& strcmp(cfg->module_conf, "dynlib ipsecmod respip iterator") != 0
813 		&& strcmp(cfg->module_conf, "ipsecmod dynlib iterator") != 0
814 		&& strcmp(cfg->module_conf, "ipsecmod dynlib respip iterator") != 0
815 		&& strcmp(cfg->module_conf, "ipsecmod validator iterator") != 0
816 		&& strcmp(cfg->module_conf, "ipsecmod respip validator iterator") != 0
817 		&& strcmp(cfg->module_conf, "dynlib ipsecmod validator iterator") != 0
818 		&& strcmp(cfg->module_conf, "dynlib ipsecmod respip validator iterator") != 0
819 		&& strcmp(cfg->module_conf, "ipsecmod dynlib validator iterator") != 0
820 		&& strcmp(cfg->module_conf, "ipsecmod dynlib respip validator iterator") != 0
821 		&& strcmp(cfg->module_conf, "ipsecmod validator dynlib iterator") != 0
822 		&& strcmp(cfg->module_conf, "ipsecmod respip validator dynlib iterator") != 0
823 #endif
824 #ifdef USE_CACHEDB
825 		&& strcmp(cfg->module_conf, "validator cachedb iterator") != 0
826 		&& strcmp(cfg->module_conf, "respip validator cachedb iterator") != 0
827 		&& strcmp(cfg->module_conf, "cachedb iterator") != 0
828 		&& strcmp(cfg->module_conf, "respip cachedb iterator") != 0
829 		&& strcmp(cfg->module_conf, "dns64 validator cachedb iterator") != 0
830 		&& strcmp(cfg->module_conf, "dns64 cachedb iterator") != 0
831 #endif
832 #if defined(WITH_PYTHONMODULE) && defined(USE_CACHEDB)
833 		&& strcmp(cfg->module_conf, "python dns64 cachedb iterator") != 0
834 		&& strcmp(cfg->module_conf, "python dns64 validator cachedb iterator") != 0
835 		&& strcmp(cfg->module_conf, "dns64 python cachedb iterator") != 0
836 		&& strcmp(cfg->module_conf, "dns64 python validator cachedb iterator") != 0
837 		&& strcmp(cfg->module_conf, "python cachedb iterator") != 0
838 		&& strcmp(cfg->module_conf, "python respip cachedb iterator") != 0
839 		&& strcmp(cfg->module_conf, "python validator cachedb iterator") != 0
840 		&& strcmp(cfg->module_conf, "python respip validator cachedb iterator") != 0
841 		&& strcmp(cfg->module_conf, "cachedb python iterator") != 0
842 		&& strcmp(cfg->module_conf, "respip cachedb python iterator") != 0
843 		&& strcmp(cfg->module_conf, "validator cachedb python iterator") != 0
844 		&& strcmp(cfg->module_conf, "respip validator cachedb python iterator") != 0
845 		&& strcmp(cfg->module_conf, "validator python cachedb iterator") != 0
846 		&& strcmp(cfg->module_conf, "respip validator python cachedb iterator") != 0
847 #endif
848 #if defined(CLIENT_SUBNET) && defined(USE_CACHEDB)
849 		&& strcmp(cfg->module_conf, "respip subnetcache validator cachedb iterator") != 0
850 		&& strcmp(cfg->module_conf, "subnetcache validator cachedb iterator") != 0
851 #endif
852 #ifdef CLIENT_SUBNET
853 		&& strcmp(cfg->module_conf, "subnetcache iterator") != 0
854 		&& strcmp(cfg->module_conf, "respip subnetcache iterator") != 0
855 		&& strcmp(cfg->module_conf, "subnetcache validator iterator") != 0
856 		&& strcmp(cfg->module_conf, "respip subnetcache validator iterator") != 0
857 		&& strcmp(cfg->module_conf, "dns64 subnetcache iterator") != 0
858 		&& strcmp(cfg->module_conf, "dns64 subnetcache validator iterator") != 0
859 		&& strcmp(cfg->module_conf, "dns64 subnetcache respip iterator") != 0
860 		&& strcmp(cfg->module_conf, "dns64 subnetcache respip validator iterator") != 0
861 #endif
862 #if defined(WITH_PYTHONMODULE) && defined(CLIENT_SUBNET)
863 		&& strcmp(cfg->module_conf, "python subnetcache iterator") != 0
864 		&& strcmp(cfg->module_conf, "python respip subnetcache iterator") != 0
865 		&& strcmp(cfg->module_conf, "subnetcache python iterator") != 0
866 		&& strcmp(cfg->module_conf, "respip subnetcache python iterator") != 0
867 		&& strcmp(cfg->module_conf, "python subnetcache validator iterator") != 0
868 		&& strcmp(cfg->module_conf, "python respip subnetcache validator iterator") != 0
869 		&& strcmp(cfg->module_conf, "subnetcache python validator iterator") != 0
870 		&& strcmp(cfg->module_conf, "respip subnetcache python validator iterator") != 0
871 		&& strcmp(cfg->module_conf, "subnetcache validator python iterator") != 0
872 		&& strcmp(cfg->module_conf, "respip subnetcache validator python iterator") != 0
873 #endif
874 #ifdef USE_IPSECMOD
875 		&& strcmp(cfg->module_conf, "ipsecmod iterator") != 0
876 		&& strcmp(cfg->module_conf, "ipsecmod respip iterator") != 0
877 		&& strcmp(cfg->module_conf, "ipsecmod validator iterator") != 0
878 		&& strcmp(cfg->module_conf, "ipsecmod respip validator iterator") != 0
879 #endif
880 #if defined(WITH_PYTHONMODULE) && defined(USE_IPSECMOD)
881 		&& strcmp(cfg->module_conf, "python ipsecmod iterator") != 0
882 		&& strcmp(cfg->module_conf, "python ipsecmod respip iterator") != 0
883 		&& strcmp(cfg->module_conf, "ipsecmod python iterator") != 0
884 		&& strcmp(cfg->module_conf, "ipsecmod python respip iterator") != 0
885 		&& strcmp(cfg->module_conf, "ipsecmod validator iterator") != 0
886 		&& strcmp(cfg->module_conf, "ipsecmod respip validator iterator") != 0
887 		&& strcmp(cfg->module_conf, "python ipsecmod validator iterator") != 0
888 		&& strcmp(cfg->module_conf, "python ipsecmod respip validator iterator") != 0
889 		&& strcmp(cfg->module_conf, "ipsecmod python validator iterator") != 0
890 		&& strcmp(cfg->module_conf, "ipsecmod python respip validator iterator") != 0
891 		&& strcmp(cfg->module_conf, "ipsecmod validator python iterator") != 0
892 		&& strcmp(cfg->module_conf, "ipsecmod respip validator python iterator") != 0
893 #endif
894 #ifdef USE_IPSET
895 		&& strcmp(cfg->module_conf, "validator ipset iterator") != 0
896 		&& strcmp(cfg->module_conf, "validator ipset respip iterator") != 0
897 		&& strcmp(cfg->module_conf, "ipset iterator") != 0
898 		&& strcmp(cfg->module_conf, "ipset respip iterator") != 0
899 #endif
900 		) {
901 		fatal_exit("module conf '%s' is not known to work",
902 			cfg->module_conf);
903 	}
904 
905 #ifdef HAVE_GETPWNAM
906 	if(cfg->username && cfg->username[0]) {
907 		if(getpwnam(cfg->username) == NULL)
908 			fatal_exit("user '%s' does not exist.", cfg->username);
909 #  ifdef HAVE_ENDPWENT
910 		endpwent();
911 #  endif
912 	}
913 #endif
914 	if(cfg->remote_control_enable && options_remote_is_address(cfg)
915 		&& cfg->control_use_cert) {
916 		check_chroot_string("server-key-file", &cfg->server_key_file,
917 			cfg->chrootdir, cfg);
918 		check_chroot_string("server-cert-file", &cfg->server_cert_file,
919 			cfg->chrootdir, cfg);
920 		if(!is_file(cfg->control_key_file))
921 			fatal_exit("control-key-file: \"%s\" does not exist",
922 				cfg->control_key_file);
923 		if(!is_file(cfg->control_cert_file))
924 			fatal_exit("control-cert-file: \"%s\" does not exist",
925 				cfg->control_cert_file);
926 	}
927 
928 	donotquerylocalhostcheck(cfg);
929 	localzonechecks(cfg);
930 	view_and_respipchecks(cfg);
931 #ifdef CLIENT_SUBNET
932 	ecs_conf_checks(cfg);
933 #endif
934 }
935 
936 /** check forwards */
937 static void
938 check_fwd(struct config_file* cfg)
939 {
940 	struct iter_forwards* fwd = forwards_create();
941 	if(!fwd || !forwards_apply_cfg(fwd, cfg)) {
942 		fatal_exit("Could not set forward zones");
943 	}
944 	forwards_delete(fwd);
945 }
946 
947 /** check hints */
948 static void
949 check_hints(struct config_file* cfg)
950 {
951 	struct iter_hints* hints = hints_create();
952 	if(!hints || !hints_apply_cfg(hints, cfg)) {
953 		fatal_exit("Could not set root or stub hints");
954 	}
955 	hints_delete(hints);
956 }
957 
958 /** check auth zones */
959 static void
960 check_auth(struct config_file* cfg)
961 {
962 	int is_rpz = 0;
963 	struct auth_zones* az = auth_zones_create();
964 	if(!az || !auth_zones_apply_cfg(az, cfg, 0, &is_rpz, NULL, NULL)) {
965 		fatal_exit("Could not setup authority zones");
966 	}
967 	auth_zones_delete(az);
968 }
969 
970 /** check config file */
971 static void
972 checkconf(const char* cfgfile, const char* opt, int final, int quiet)
973 {
974 	char oldwd[4096];
975 	struct config_file* cfg = config_create();
976 	if(!cfg)
977 		fatal_exit("out of memory");
978 	oldwd[0] = 0;
979 	if(!getcwd(oldwd, sizeof(oldwd))) {
980 		log_err("cannot getcwd: %s", strerror(errno));
981 		oldwd[0] = 0;
982 	}
983 	if(!config_read(cfg, cfgfile, NULL)) {
984 		/* config_read prints messages to stderr */
985 		config_delete(cfg);
986 		exit(1);
987 	}
988 	if(oldwd[0] && chdir(oldwd) == -1)
989 		log_err("cannot chdir(%s): %s", oldwd, strerror(errno));
990 	if(opt) {
991 		print_option(cfg, opt, final);
992 		config_delete(cfg);
993 		return;
994 	}
995 	morechecks(cfg);
996 	check_mod(cfg, iter_get_funcblock());
997 	check_mod(cfg, val_get_funcblock());
998 #ifdef WITH_PYTHONMODULE
999 	if(strstr(cfg->module_conf, "python"))
1000 		check_mod(cfg, pythonmod_get_funcblock());
1001 #endif
1002 	check_fwd(cfg);
1003 	check_hints(cfg);
1004 	check_auth(cfg);
1005 	if(!quiet) { printf("unbound-checkconf: no errors in %s\n", cfgfile); }
1006 	config_delete(cfg);
1007 }
1008 
1009 /** getopt global, in case header files fail to declare it. */
1010 extern int optind;
1011 /** getopt global, in case header files fail to declare it. */
1012 extern char* optarg;
1013 
1014 /** Main routine for checkconf */
1015 int main(int argc, char* argv[])
1016 {
1017 	int c;
1018 	int final = 0;
1019 	int quiet = 0;
1020 	const char* f;
1021 	const char* opt = NULL;
1022 	const char* cfgfile = CONFIGFILE;
1023 	checklock_start();
1024 	log_ident_set("unbound-checkconf");
1025 	log_init(NULL, 0, NULL);
1026 #ifdef USE_WINSOCK
1027 	/* use registry config file in preference to compiletime location */
1028 	if(!(cfgfile=w_lookup_reg_str("Software\\Unbound", "ConfigFile")))
1029 		cfgfile = CONFIGFILE;
1030 #endif /* USE_WINSOCK */
1031 	/* parse the options */
1032 	while( (c=getopt(argc, argv, "fhqo:")) != -1) {
1033 		switch(c) {
1034 		case 'f':
1035 			final = 1;
1036 			break;
1037 		case 'o':
1038 			opt = optarg;
1039 			break;
1040 		case 'q':
1041 			quiet = 1;
1042 			break;
1043 		case '?':
1044 		case 'h':
1045 		default:
1046 			usage();
1047 		}
1048 	}
1049 	argc -= optind;
1050 	argv += optind;
1051 	if(argc != 0 && argc != 1)
1052 		usage();
1053 	if(argc == 1)
1054 		f = argv[0];
1055 	else	f = cfgfile;
1056 	checkconf(f, opt, final, quiet);
1057 	checklock_stop();
1058 	return 0;
1059 }
1060