Project

General

Profile

Download (22.8 KB) Statistics
| Branch: | Tag: | Revision:
1 f20afeb6 Warren Baker
<?php
2
/*
3 ac24dc24 Renato Botelho
 * unbound.inc
4
 *
5
 * part of pfSense (https://www.pfsense.org)
6 c5d81585 Renato Botelho
 * Copyright (c) 2015 Warren Baker <warren@percol8.co.za>
7 81299b5c Renato Botelho
 * Copyright (c) 2015-2016 Rubicon Communications, LLC (Netgate)
8 ac24dc24 Renato Botelho
 * All rights reserved.
9
 *
10
 * originally part of m0n0wall (http://m0n0.ch/wall)
11 c5d81585 Renato Botelho
 * Copyright (c) 2003-2004 Manuel Kasper <mk@neon1.net>.
12 ac24dc24 Renato Botelho
 * All rights reserved.
13
 *
14 b12ea3fb Renato Botelho
 * Licensed under the Apache License, Version 2.0 (the "License");
15
 * you may not use this file except in compliance with the License.
16
 * You may obtain a copy of the License at
17 ac24dc24 Renato Botelho
 *
18 b12ea3fb Renato Botelho
 * http://www.apache.org/licenses/LICENSE-2.0
19 ac24dc24 Renato Botelho
 *
20 b12ea3fb Renato Botelho
 * Unless required by applicable law or agreed to in writing, software
21
 * distributed under the License is distributed on an "AS IS" BASIS,
22
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23
 * See the License for the specific language governing permissions and
24
 * limitations under the License.
25 ac24dc24 Renato Botelho
 */
26 f20afeb6 Warren Baker
27
/* include all configuration functions */
28
require_once("config.inc");
29
require_once("functions.inc");
30 3bdf2a70 Chris Buechler
require_once("filter.inc");
31
require_once("shaper.inc");
32 f20afeb6 Warren Baker
33 1548bd35 Phil Davis
function create_unbound_chroot_path($cfgsubdir = "") {
34 e318d592 Phil Davis
	global $config, $g;
35
36
	// Configure chroot
37
	if (!is_dir($g['unbound_chroot_path'])) {
38
		mkdir($g['unbound_chroot_path']);
39
		chown($g['unbound_chroot_path'], "unbound");
40
		chgrp($g['unbound_chroot_path'], "unbound");
41
	}
42
43 1548bd35 Phil Davis
	if ($cfgsubdir != "") {
44
		$cfgdir = $g['unbound_chroot_path'] . $cfgsubdir;
45
		if (!is_dir($cfgdir)) {
46
			mkdir($cfgdir);
47
			chown($cfgdir, "unbound");
48
			chgrp($cfgdir, "unbound");
49
		}
50
	}
51 e318d592 Phil Davis
}
52
53 f20afeb6 Warren Baker
/* Optimize Unbound for environment */
54
function unbound_optimization() {
55 fe9d4894 Renato Botelho
	global $config;
56
57
	$optimization_settings = array();
58
59 751533a2 Phil Davis
	/*
60 fe9d4894 Renato Botelho
	 * Set the number of threads equal to number of CPUs.
61
	 * Use 1 to disable threading, if for some reason this sysctl fails.
62
	 */
63
	$numprocs = intval(get_single_sysctl('kern.smp.cpus'));
64 46762efe Warren Baker
	if ($numprocs > 1) {
65 fe9d4894 Renato Botelho
		$optimization['number_threads'] = "num-threads: {$numprocs}";
66 086cf944 Phil Davis
		$optimize_num = pow(2, floor(log($numprocs, 2)));
67 46762efe Warren Baker
	} else {
68 fe9d4894 Renato Botelho
		$optimization['number_threads'] = "num-threads: 1";
69 46762efe Warren Baker
		$optimize_num = 4;
70
	}
71 fe9d4894 Renato Botelho
72
	// Slabs to help reduce lock contention.
73 46762efe Warren Baker
	$optimization['msg_cache_slabs'] = "msg-cache-slabs: {$optimize_num}";
74
	$optimization['rrset_cache_slabs'] = "rrset-cache-slabs: {$optimize_num}";
75
	$optimization['infra_cache_slabs'] = "infra-cache-slabs: {$optimize_num}";
76
	$optimization['key_cache_slabs'] = "key-cache-slabs: {$optimize_num}";
77 fe9d4894 Renato Botelho
78
	/*
79
	 * Larger socket buffer for busy servers
80
	 * Check that it is set to 4MB (by default the OS has it configured to 4MB)
81
	 */
82 d87fcac9 Ermal
	if (is_array($config['sysctl']) && is_array($config['sysctl']['item'])) {
83
		foreach ($config['sysctl']['item'] as $tunable) {
84
			if ($tunable['tunable'] == 'kern.ipc.maxsockbuf') {
85 ad04bbbf Warren Baker
				$so = floor(($tunable['value']/1024/1024)-4);
86 d87fcac9 Ermal
				// Check to ensure that the number is not a negative
87 ad04bbbf Warren Baker
				if ($so >= 4) {
88
					// Limit to 32MB, users might set maxsockbuf very high for other reasons.
89 4708c6f0 Phil Davis
					// We do not want unbound to fail because of that.
90 ad04bbbf Warren Baker
					$so = min($so, 32);
91 d87fcac9 Ermal
					$optimization['so_rcvbuf'] = "so-rcvbuf: {$so}m";
92 ad04bbbf Warren Baker
				} else {
93 d87fcac9 Ermal
					unset($optimization['so_rcvbuf']);
94 ad04bbbf Warren Baker
				}
95 d87fcac9 Ermal
			}
96 fe9d4894 Renato Botelho
		}
97
	}
98
	// Safety check in case kern.ipc.maxsockbuf is not available.
99 751533a2 Phil Davis
	if (!isset($optimization['so_rcvbuf'])) {
100 fe9d4894 Renato Botelho
		$optimization['so_rcvbuf'] = "#so-rcvbuf: 4m";
101 751533a2 Phil Davis
	}
102 fe9d4894 Renato Botelho
103
	return $optimization;
104 f20afeb6 Warren Baker
105
}
106
107 932711c7 Matt Smith
function test_unbound_config($unboundcfg, &$output) {
108
	global $g;
109
110 1548bd35 Phil Davis
	$cfgsubdir = "/test";
111
	unbound_generate_config($unboundcfg, $cfgsubdir);
112
	unbound_remote_control_setup($cfgsubdir);
113
	do_as_unbound_user("unbound-anchor", $cfgsubdir);
114
115
	$cfgdir = "{$g['unbound_chroot_path']}{$cfgsubdir}";
116 932711c7 Matt Smith
117
	$rv = 0;
118 1548bd35 Phil Davis
	exec("/usr/local/sbin/unbound-checkconf {$cfgdir}/unbound.conf 2>&1", $output, $rv);
119
	rmdir_recursive($cfgdir);
120 932711c7 Matt Smith
121
	return $rv;
122
}
123
124
125 1548bd35 Phil Davis
function unbound_generate_config($unboundcfg = NULL, $cfgsubdir = "") {
126 a569071d Phil Davis
	global $g;
127 932711c7 Matt Smith
128 1548bd35 Phil Davis
	$unboundcfgtxt = unbound_generate_config_text($unboundcfg, $cfgsubdir);
129 932711c7 Matt Smith
130
	// Configure static Host entries
131 1548bd35 Phil Davis
	unbound_add_host_entries($cfgsubdir);
132 932711c7 Matt Smith
133
	// Configure Domain Overrides
134 1548bd35 Phil Davis
	unbound_add_domain_overrides("", $cfgsubdir);
135 932711c7 Matt Smith
136
	// Configure Unbound access-lists
137 1548bd35 Phil Davis
	unbound_acls_config($cfgsubdir);
138 932711c7 Matt Smith
139 1548bd35 Phil Davis
	create_unbound_chroot_path($cfgsubdir);
140
	file_put_contents("{$g['unbound_chroot_path']}{$cfgsubdir}/unbound.conf", $unboundcfgtxt);
141 932711c7 Matt Smith
}
142
143
144 1548bd35 Phil Davis
function unbound_generate_config_text($unboundcfg = NULL, $cfgsubdir = "") {
145 932711c7 Matt Smith
146 fe9d4894 Renato Botelho
	global $config, $g;
147 932711c7 Matt Smith
	if (is_null($unboundcfg)) {
148
		$unboundcfg = $config['unbound'];
149
	}
150 fe9d4894 Renato Botelho
151
	// Setup optimization
152
	$optimization = unbound_optimization();
153
154
	// Setup DNSSEC support
155 932711c7 Matt Smith
	if (isset($unboundcfg['dnssec'])) {
156 fe9d4894 Renato Botelho
		$module_config = "validator iterator";
157 1548bd35 Phil Davis
		$anchor_file = "auto-trust-anchor-file: {$g['unbound_chroot_path']}{$cfgsubdir}/root.key";
158 751533a2 Phil Davis
	} else {
159 fe9d4894 Renato Botelho
		$module_config = "iterator";
160 751533a2 Phil Davis
	}
161 fe9d4894 Renato Botelho
162
	// Setup DNS Rebinding
163
	if (!isset($config['system']['webgui']['nodnsrebindcheck'])) {
164
		// Private-addresses for DNS Rebinding
165
		$private_addr = <<<EOF
166 f20afeb6 Warren Baker
# For DNS Rebinding prevention
167
private-address: 10.0.0.0/8
168
private-address: 172.16.0.0/12
169 c683f627 Chris Buechler
private-address: 169.254.0.0/16
170 f20afeb6 Warren Baker
private-address: 192.168.0.0/16
171
private-address: fd00::/8
172
private-address: fe80::/10
173
EOF;
174 fe9d4894 Renato Botelho
	}
175
176
	// Determine interfaces to run on
177
	$bindints = "";
178 932711c7 Matt Smith
	if (!empty($unboundcfg['active_interface'])) {
179
		$active_interfaces = explode(",", $unboundcfg['active_interface']);
180 b7960673 Chris Buechler
		if (in_array("all", $active_interfaces, true)) {
181
			$bindints .= "interface: 0.0.0.0\n";
182
			$bindints .= "interface: ::0\n";
183 f358fe3f Chris Buechler
			$bindints .= "interface-automatic: yes\n";
184 b7960673 Chris Buechler
		} else {
185 751533a2 Phil Davis
			foreach ($active_interfaces as $ubif) {
186 a0e9e17d Chris Buechler
				if (is_ipaddr($ubif)) {
187 6cffaccc Chris Buechler
					$bindints .= "interface: $ubif\n";
188 a0e9e17d Chris Buechler
				} else {
189
					$intip = get_interface_ip($ubif);
190 751533a2 Phil Davis
					if (is_ipaddrv4($intip)) {
191 a0e9e17d Chris Buechler
						$bindints .= "interface: $intip\n";
192 751533a2 Phil Davis
					}
193 a0e9e17d Chris Buechler
					$intip = get_interface_ipv6($ubif);
194 751533a2 Phil Davis
					if (is_ipaddrv6($intip)) {
195 7cc0a76b Luiz Otavio O Souza
						$bindints .= "interface: $intip\n";
196 751533a2 Phil Davis
					}
197 a0e9e17d Chris Buechler
				}
198 751533a2 Phil Davis
			}
199 fe9d4894 Renato Botelho
		}
200
	} else {
201
		$bindints .= "interface: 0.0.0.0\n";
202
		$bindints .= "interface: ::0\n";
203 a2cbbb74 jim-p
		/* If the active interface array is empty, treat it the same as "All" as is done above. Otherwise it breaks CARP with a default config. */
204
		$bindints .= "interface-automatic: yes\n";
205 fe9d4894 Renato Botelho
	}
206
207
	// Determine interfaces to run on
208
	$outgoingints = "";
209 932711c7 Matt Smith
	if (!empty($unboundcfg['outgoing_interface'])) {
210 fe9d4894 Renato Botelho
		$outgoingints = "# Outgoing interfaces to be used\n";
211 932711c7 Matt Smith
		$outgoing_interfaces = explode(",", $unboundcfg['outgoing_interface']);
212 751533a2 Phil Davis
		foreach ($outgoing_interfaces as $outif) {
213 fe9d4894 Renato Botelho
			$outip = get_interface_ip($outif);
214 c37ffea8 Chris Buechler
			if (is_ipaddr($outip)) {
215 fe9d4894 Renato Botelho
				$outgoingints .= "outgoing-interface: $outip\n";
216 751533a2 Phil Davis
			}
217 fe9d4894 Renato Botelho
			$outip = get_interface_ipv6($outif);
218 c37ffea8 Chris Buechler
			if (is_ipaddrv6($outip)) {
219 fe9d4894 Renato Botelho
				$outgoingints .= "outgoing-interface: $outip\n";
220 751533a2 Phil Davis
			}
221 fe9d4894 Renato Botelho
		}
222
	}
223
224
	// Allow DNS Rebind for forwarded domains
225 932711c7 Matt Smith
	if (isset($unboundcfg['domainoverrides']) && is_array($unboundcfg['domainoverrides'])) {
226 984abd66 Phil Davis
		if (!isset($config['system']['webgui']['nodnsrebindcheck'])) {
227
			$private_domains = "# Set private domains in case authoritative name server returns a Private IP address\n";
228
			$private_domains .= unbound_add_domain_overrides("private");
229
		}
230
		$reverse_zones .= unbound_add_domain_overrides("reverse");
231 fe9d4894 Renato Botelho
	}
232
233 ab8f10f2 Phil Davis
	// Configure Unbound statistics
234
	$statistics = unbound_statistics();
235
236 fe9d4894 Renato Botelho
	// Add custom Unbound options
237 932711c7 Matt Smith
	if ($unboundcfg['custom_options']) {
238
		$custom_options_source = explode("\n", base64_decode($unboundcfg['custom_options']));
239 b9608ab6 Phil Davis
		$custom_options = "# Unbound custom options\n";
240 751533a2 Phil Davis
		foreach ($custom_options_source as $ent) {
241 b9608ab6 Phil Davis
			$custom_options .= $ent."\n";
242 751533a2 Phil Davis
		}
243 fe9d4894 Renato Botelho
	}
244
245
	// Server configuration variables
246 932711c7 Matt Smith
	$port = (is_port($unboundcfg['port'])) ? $unboundcfg['port'] : "53";
247
	$hide_identity = isset($unboundcfg['hideidentity']) ? "yes" : "no";
248
	$hide_version = isset($unboundcfg['hideversion']) ? "yes" : "no";
249
	$harden_dnssec_stripped = isset($unboundcfg['dnssecstripped']) ? "yes" : "no";
250
	$prefetch = isset($unboundcfg['prefetch']) ? "yes" : "no";
251
	$prefetch_key = isset($unboundcfg['prefetchkey']) ? "yes" : "no";
252 f8a475f5 lukehamburg
	$outgoing_num_tcp = isset($unboundcfg['outgoing_num_tcp']) ? $unboundcfg['outgoing_num_tcp'] : "10";
253
	$incoming_num_tcp = isset($unboundcfg['incoming_num_tcp']) ? $unboundcfg['incoming_num_tcp'] : "10";
254 932711c7 Matt Smith
	$edns_buffer_size = (!empty($unboundcfg['edns_buffer_size'])) ? $unboundcfg['edns_buffer_size'] : "4096";
255
	$num_queries_per_thread = (!empty($unboundcfg['num_queries_per_thread'])) ? $unboundcfg['num_queries_per_thread'] : "4096";
256
	$jostle_timeout = (!empty($unboundcfg['jostle_timeout'])) ? $unboundcfg['jostle_timeout'] : "200";
257
	$cache_max_ttl = (!empty($unboundcfg['cache_max_ttl'])) ? $unboundcfg['cache_max_ttl'] : "86400";
258
	$cache_min_ttl = (!empty($unboundcfg['cache_min_ttl'])) ? $unboundcfg['cache_min_ttl'] : "0";
259
	$infra_host_ttl = (!empty($unboundcfg['infra_host_ttl'])) ? $unboundcfg['infra_host_ttl'] : "900";
260
	$infra_cache_numhosts = (!empty($unboundcfg['infra_cache_numhosts'])) ? $unboundcfg['infra_cache_numhosts'] : "10000";
261
	$unwanted_reply_threshold = (!empty($unboundcfg['unwanted_reply_threshold'])) ? $unboundcfg['unwanted_reply_threshold'] : "0";
262 751533a2 Phil Davis
	if ($unwanted_reply_threshold == "disabled") {
263 b9608ab6 Phil Davis
		$unwanted_reply_threshold = "0";
264 751533a2 Phil Davis
	}
265 932711c7 Matt Smith
	$msg_cache_size = (!empty($unboundcfg['msgcachesize'])) ? $unboundcfg['msgcachesize'] : "4";
266
	$verbosity = isset($unboundcfg['log_verbosity']) ? $unboundcfg['log_verbosity'] : 1;
267
	$use_caps = isset($unboundcfg['use_caps']) ? "yes" : "no";
268 fe9d4894 Renato Botelho
269 a110a0cb Phil Davis
	// Set up forwarding if it is configured
270 932711c7 Matt Smith
	if (isset($unboundcfg['forwarding'])) {
271 fe9d4894 Renato Botelho
		$dnsservers = array();
272
		if (isset($config['system']['dnsallowoverride'])) {
273
			$ns = array_unique(get_nameservers());
274 751533a2 Phil Davis
			foreach ($ns as $nameserver) {
275
				if ($nameserver) {
276 fe9d4894 Renato Botelho
					$dnsservers[] = $nameserver;
277 751533a2 Phil Davis
				}
278 fe9d4894 Renato Botelho
			}
279 9b837c5d Phil Davis
		} else {
280
			$ns = array();
281 a110a0cb Phil Davis
		}
282
		$sys_dnsservers = array_unique(get_dns_servers());
283
		foreach ($sys_dnsservers as $sys_dnsserver) {
284
			if ($sys_dnsserver && (!in_array($sys_dnsserver, $ns))) {
285
				$dnsservers[] = $sys_dnsserver;
286 fe9d4894 Renato Botelho
			}
287
		}
288
289
		if (!empty($dnsservers)) {
290
			$forward_conf .=<<<EOD
291 75e6d1b2 Warren Baker
# Forwarding
292 be5aa310 Warren Baker
forward-zone:
293 fe9d4894 Renato Botelho
	name: "."
294 be5aa310 Warren Baker
295
EOD;
296 751533a2 Phil Davis
			foreach ($dnsservers as $dnsserver) {
297 84588e00 Chris Buechler
				if (is_ipaddr($dnsserver) && !ip_in_subnet($dnsserver, "127.0.0.0/8")) {
298
					$forward_conf .= "\tforward-addr: $dnsserver\n";
299
				}
300 751533a2 Phil Davis
			}
301 fe9d4894 Renato Botelho
		}
302 751533a2 Phil Davis
	} else {
303 fe9d4894 Renato Botelho
		$forward_conf = "";
304 751533a2 Phil Davis
	}
305 be5aa310 Warren Baker
306 2597415b Chris Buechler
	// Size of the RRset cache == 2 * msg-cache-size per Unbound's recommendations
307
	$rrset_cache_size = $msg_cache_size * 2;
308
309 fe9d4894 Renato Botelho
	$unboundconf = <<<EOD
310 f20afeb6 Warren Baker
##########################
311
# Unbound Configuration
312
##########################
313
314
##
315
# Server configuration
316
##
317
server:
318 984abd66 Phil Davis
{$reverse_zones}
319 f20afeb6 Warren Baker
chroot: {$g['unbound_chroot_path']}
320
username: "unbound"
321 56a87b19 Warren Baker
directory: "{$g['unbound_chroot_path']}"
322 f20afeb6 Warren Baker
pidfile: "/var/run/unbound.pid"
323
use-syslog: yes
324 d12889b0 Warren Baker
port: {$port}
325 56a87b19 Warren Baker
verbosity: {$verbosity}
326 b9608ab6 Phil Davis
hide-identity: {$hide_identity}
327
hide-version: {$hide_version}
328 5c7c369f Chris Buechler
harden-glue: yes
329 f20afeb6 Warren Baker
do-ip4: yes
330
do-ip6: yes
331
do-udp: yes
332
do-tcp: yes
333
do-daemonize: yes
334
module-config: "{$module_config}"
335 b9608ab6 Phil Davis
unwanted-reply-threshold: {$unwanted_reply_threshold}
336
num-queries-per-thread: {$num_queries_per_thread}
337
jostle-timeout: {$jostle_timeout}
338
infra-host-ttl: {$infra_host_ttl}
339
infra-cache-numhosts: {$infra_cache_numhosts}
340
outgoing-num-tcp: {$outgoing_num_tcp}
341
incoming-num-tcp: {$incoming_num_tcp}
342
edns-buffer-size: {$edns_buffer_size}
343 56a87b19 Warren Baker
cache-max-ttl: {$cache_max_ttl}
344
cache-min-ttl: {$cache_min_ttl}
345 b9608ab6 Phil Davis
harden-dnssec-stripped: {$harden_dnssec_stripped}
346
msg-cache-size: {$msg_cache_size}m
347 2597415b Chris Buechler
rrset-cache-size: {$rrset_cache_size}m
348
349 f20afeb6 Warren Baker
{$optimization['number_threads']}
350
{$optimization['msg_cache_slabs']}
351
{$optimization['rrset_cache_slabs']}
352
{$optimization['infra_cache_slabs']}
353
{$optimization['key_cache_slabs']}
354 2cbcc256 Warren Baker
outgoing-range: 4096
355 f20afeb6 Warren Baker
{$optimization['so_rcvbuf']}
356
{$anchor_file}
357 56a87b19 Warren Baker
prefetch: {$prefetch}
358
prefetch-key: {$prefetch_key}
359 a771a6ae Warren Baker
use-caps-for-id: {$use_caps}
360 f20afeb6 Warren Baker
# Statistics
361
{$statistics}
362
# Interface IP(s) to bind to
363 16a3108f Warren Baker
{$bindints}
364 6374fb57 Warren Baker
{$outgoingints}
365 f20afeb6 Warren Baker
366
# DNS Rebinding
367
{$private_addr}
368
{$private_domains}
369
370 4e8e8cc8 Warren Baker
# Access lists
371 1548bd35 Phil Davis
include: {$g['unbound_chroot_path']}{$cfgsubdir}/access_lists.conf
372 4e8e8cc8 Warren Baker
373 f20afeb6 Warren Baker
# Static host entries
374 1548bd35 Phil Davis
include: {$g['unbound_chroot_path']}{$cfgsubdir}/host_entries.conf
375 f20afeb6 Warren Baker
376 b3977493 Renato Botelho
# dhcp lease entries
377 1548bd35 Phil Davis
include: {$g['unbound_chroot_path']}{$cfgsubdir}/dhcpleases_entries.conf
378 b3977493 Renato Botelho
379 f20afeb6 Warren Baker
# Domain overrides
380 1548bd35 Phil Davis
include: {$g['unbound_chroot_path']}{$cfgsubdir}/domainoverrides.conf
381 be5aa310 Warren Baker
{$forward_conf}
382
383 f20afeb6 Warren Baker
{$custom_options}
384
385
###
386
# Remote Control Config
387
###
388 1548bd35 Phil Davis
include: {$g['unbound_chroot_path']}{$cfgsubdir}/remotecontrol.conf
389 f20afeb6 Warren Baker
390
EOD;
391
392 932711c7 Matt Smith
	return $unboundconf;
393 f20afeb6 Warren Baker
}
394
395 1548bd35 Phil Davis
function unbound_remote_control_setup($cfgsubdir = "") {
396 fe9d4894 Renato Botelho
	global $g;
397 f20afeb6 Warren Baker
398 1548bd35 Phil Davis
	if (!file_exists("{$g['unbound_chroot_path']}{$cfgsubdir}/remotecontrol.conf") || !file_exists("{$g['unbound_chroot_path']}{$cfgsubdir}/unbound_control.key")) {
399 fe9d4894 Renato Botelho
		$remotcfg = <<<EOF
400 f20afeb6 Warren Baker
remote-control:
401 fe9d4894 Renato Botelho
	control-enable: yes
402
	control-interface: 127.0.0.1
403
	control-port: 953
404 1548bd35 Phil Davis
	server-key-file: "{$g['unbound_chroot_path']}{$cfgsubdir}/unbound_server.key"
405
	server-cert-file: "{$g['unbound_chroot_path']}{$cfgsubdir}/unbound_server.pem"
406
	control-key-file: "{$g['unbound_chroot_path']}{$cfgsubdir}/unbound_control.key"
407
	control-cert-file: "{$g['unbound_chroot_path']}{$cfgsubdir}/unbound_control.pem"
408 56a87b19 Warren Baker
409 f20afeb6 Warren Baker
EOF;
410
411 1548bd35 Phil Davis
		create_unbound_chroot_path($cfgsubdir);
412
		file_put_contents("{$g['unbound_chroot_path']}{$cfgsubdir}/remotecontrol.conf", $remotcfg);
413 f20afeb6 Warren Baker
414 fe9d4894 Renato Botelho
		// Generate our keys
415 1548bd35 Phil Davis
		do_as_unbound_user("unbound-control-setup", $cfgsubdir);
416 f20afeb6 Warren Baker
417 fe9d4894 Renato Botelho
	}
418 56a87b19 Warren Baker
}
419 f20afeb6 Warren Baker
420
function sync_unbound_service() {
421 fe9d4894 Renato Botelho
	global $config, $g;
422
423 e318d592 Phil Davis
	create_unbound_chroot_path();
424 fe9d4894 Renato Botelho
425
	// Configure our Unbound service
426
	do_as_unbound_user("unbound-anchor");
427
	unbound_remote_control_setup();
428
	unbound_generate_config();
429
	do_as_unbound_user("start");
430
	require_once("service-utils.inc");
431 751533a2 Phil Davis
	if (is_service_running("unbound")) {
432 fe9d4894 Renato Botelho
		do_as_unbound_user("restore_cache");
433 751533a2 Phil Davis
	}
434 f20afeb6 Warren Baker
435
}
436
437
function unbound_acl_id_used($id) {
438 fe9d4894 Renato Botelho
	global $config;
439 f20afeb6 Warren Baker
440 751533a2 Phil Davis
	if (is_array($config['unbound']['acls'])) {
441
		foreach ($config['unbound']['acls'] as & $acls) {
442
			if ($id == $acls['aclid']) {
443 fe9d4894 Renato Botelho
				return true;
444 751533a2 Phil Davis
			}
445
		}
446
	}
447 f20afeb6 Warren Baker
448 fe9d4894 Renato Botelho
	return false;
449 f20afeb6 Warren Baker
}
450
451
function unbound_get_next_id() {
452 fe9d4894 Renato Botelho
	$aclid = 0;
453 751533a2 Phil Davis
	while (unbound_acl_id_used($aclid)) {
454 fe9d4894 Renato Botelho
		$aclid++;
455 751533a2 Phil Davis
	}
456 fe9d4894 Renato Botelho
	return $aclid;
457 f20afeb6 Warren Baker
}
458
459
// Execute commands as the user unbound
460 1548bd35 Phil Davis
function do_as_unbound_user($cmd, $param1 = "") {
461 fe9d4894 Renato Botelho
	global $g;
462
463
	switch ($cmd) {
464 751533a2 Phil Davis
		case "start":
465
			mwexec("/usr/local/sbin/unbound -c {$g['unbound_chroot_path']}/unbound.conf");
466
			break;
467
		case "stop":
468
			mwexec("echo '/usr/local/sbin/unbound-control stop' | /usr/bin/su -m unbound", true);
469
			break;
470
		case "reload":
471
			mwexec("echo '/usr/local/sbin/unbound-control reload' | /usr/bin/su -m unbound", true);
472
			break;
473
		case "unbound-anchor":
474 1548bd35 Phil Davis
			$root_key_file = "{$g['unbound_chroot_path']}{$param1}/root.key";
475 4eeb2809 Chris Buechler
			// sanity check root.key because unbound-anchor will fail without manual removal otherwise. redmine #5334
476 1548bd35 Phil Davis
			if (file_exists($root_key_file)) {
477
				$rootkeycheck = mwexec("/usr/bin/grep 'autotrust trust anchor file' {$root_key_file}", true);
478 4eeb2809 Chris Buechler
				if ($rootkeycheck != "0") {
479 1548bd35 Phil Davis
					log_error("Unbound {$root_key_file} file is corrupt, removing and recreating.");
480
					unlink_if_exists($root_key_file);
481 4eeb2809 Chris Buechler
				}
482
			}
483 1548bd35 Phil Davis
			mwexec("echo '/usr/local/sbin/unbound-anchor -a {$root_key_file}' | /usr/bin/su -m unbound", true);
484
			// Only sync the file if this is the real (default) one, not a test one.
485
			if ($param1 == "") {
486
				pfSense_fsync($root_key_file);
487
			}
488 751533a2 Phil Davis
			break;
489
		case "unbound-control-setup":
490 1548bd35 Phil Davis
			mwexec("echo '/usr/local/sbin/unbound-control-setup -d {$g['unbound_chroot_path']}{$param1}' | /usr/bin/su -m unbound", true);
491 751533a2 Phil Davis
			break;
492
		default:
493
			break;
494 fe9d4894 Renato Botelho
	}
495 f20afeb6 Warren Baker
}
496
497 1548bd35 Phil Davis
function unbound_add_domain_overrides($pvt_rev="", $cfgsubdir = "") {
498 fe9d4894 Renato Botelho
	global $config, $g;
499
500
	$domains = $config['unbound']['domainoverrides'];
501
502
	$sorted_domains = msort($domains, "domain");
503
	$result = array();
504 751533a2 Phil Davis
	foreach ($sorted_domains as $domain) {
505 fe9d4894 Renato Botelho
		$domain_key = current($domain);
506 751533a2 Phil Davis
		if (!isset($result[$domain_key])) {
507 fe9d4894 Renato Botelho
			$result[$domain_key] = array();
508 751533a2 Phil Davis
		}
509 fe9d4894 Renato Botelho
		$result[$domain_key][] = $domain['ip'];
510
	}
511
512
	// Domain overrides that have multiple entries need multiple stub-addr: added
513
	$domain_entries = "";
514 751533a2 Phil Davis
	foreach ($result as $domain=>$ips) {
515 984abd66 Phil Davis
		if ($pvt_rev == "private") {
516 fe9d4894 Renato Botelho
			$domain_entries .= "private-domain: \"$domain\"\n";
517
			$domain_entries .= "domain-insecure: \"$domain\"\n";
518 984abd66 Phil Davis
		} else if ($pvt_rev == "reverse") {
519 086cf944 Phil Davis
			if ((substr($domain, -14) == ".in-addr.arpa.") || (substr($domain, -13) == ".in-addr.arpa")) {
520 984abd66 Phil Davis
				$domain_entries .= "local-zone: \"$domain\" typetransparent\n";
521
			}
522 fe9d4894 Renato Botelho
		} else {
523 0bde07b7 Chris Buechler
			$domain_entries .= "forward-zone:\n";
524 fe9d4894 Renato Botelho
			$domain_entries .= "\tname: \"$domain\"\n";
525 751533a2 Phil Davis
			foreach ($ips as $ip) {
526 0bde07b7 Chris Buechler
				$domain_entries .= "\tforward-addr: $ip\n";
527 751533a2 Phil Davis
			}
528 fe9d4894 Renato Botelho
		}
529
	}
530
531 751533a2 Phil Davis
	if ($pvt_rev != "") {
532 fe9d4894 Renato Botelho
		return $domain_entries;
533 751533a2 Phil Davis
	} else {
534 1548bd35 Phil Davis
		create_unbound_chroot_path($cfgsubdir);
535
		file_put_contents("{$g['unbound_chroot_path']}{$cfgsubdir}/domainoverrides.conf", $domain_entries);
536 e318d592 Phil Davis
	}
537 f20afeb6 Warren Baker
}
538
539 1548bd35 Phil Davis
function unbound_add_host_entries($cfgsubdir = "") {
540 fe9d4894 Renato Botelho
	global $config, $g;
541
542 9a83872f NOYB
	// Make sure the config setting is a valid unbound local zone type.  If not use "transparent".
543
	if (array_key_exists($config['unbound']['system_domain_local_zone_type'], unbound_local_zone_types())) {
544 ca47c065 NOYB
		$system_domain_local_zone_type = $config['unbound']['system_domain_local_zone_type'];
545 9a83872f NOYB
	} else {
546
		$system_domain_local_zone_type = "transparent";
547 ca47c065 NOYB
	}
548
549 77d9edf5 NOYB
	$unbound_entries = "local-zone: \"{$config['system']['domain']}\" {$system_domain_local_zone_type}\n";
550 fe9d4894 Renato Botelho
551 ac446eac Renato Botelho
	$hosts = system_hosts_entries($config['unbound']);
552 06266c34 Lorenz Schori
	$added_ptr = array();
553 b3977493 Renato Botelho
	foreach ($hosts as $host) {
554 751533a2 Phil Davis
		if (is_ipaddrv4($host['ipaddr'])) {
555 b3977493 Renato Botelho
			$type = 'A';
556 751533a2 Phil Davis
		} else if (is_ipaddrv6($host['ipaddr'])) {
557 b3977493 Renato Botelho
			$type = 'AAAA';
558 751533a2 Phil Davis
		} else {
559 b3977493 Renato Botelho
			continue;
560 751533a2 Phil Davis
		}
561 fe9d4894 Renato Botelho
562 751533a2 Phil Davis
		if (!$added_ptr[$host['ipaddr']]) {
563 06266c34 Lorenz Schori
			$unbound_entries .= "local-data-ptr: \"{$host['ipaddr']} {$host['fqdn']}\"\n";
564 f29610b0 Lorenz Schori
			$added_ptr[$host['ipaddr']] = true;
565 06266c34 Lorenz Schori
		}
566 b3977493 Renato Botelho
		$unbound_entries .= "local-data: \"{$host['fqdn']} {$type} {$host['ipaddr']}\"\n";
567 fe9d4894 Renato Botelho
	}
568
569
	// Write out entries
570 1548bd35 Phil Davis
	create_unbound_chroot_path($cfgsubdir);
571
	file_put_contents("{$g['unbound_chroot_path']}{$cfgsubdir}/host_entries.conf", $unbound_entries);
572 b3977493 Renato Botelho
573
	/* dhcpleases will write to this config file, make sure it exists */
574 1548bd35 Phil Davis
	@touch("{$g['unbound_chroot_path']}{$cfgsubdir}/dhcpleases_entries.conf");
575 f20afeb6 Warren Baker
}
576
577 56a87b19 Warren Baker
function unbound_control($action) {
578 fe9d4894 Renato Botelho
	global $config, $g;
579
580
	$cache_dumpfile = "/var/tmp/unbound_cache";
581
582
	switch ($action) {
583
	case "start":
584
		// Start Unbound
585
		if ($config['unbound']['enable'] == "on") {
586 751533a2 Phil Davis
			if (!is_service_running("unbound")) {
587 fe9d4894 Renato Botelho
				do_as_unbound_user("start");
588 751533a2 Phil Davis
			}
589 fe9d4894 Renato Botelho
		}
590
		break;
591
	case "stop":
592 751533a2 Phil Davis
		if ($config['unbound']['enable'] == "on") {
593 fe9d4894 Renato Botelho
			do_as_unbound_user("stop");
594 751533a2 Phil Davis
		}
595 fe9d4894 Renato Botelho
		break;
596
	case "reload":
597 751533a2 Phil Davis
		if ($config['unbound']['enable'] == "on") {
598 fe9d4894 Renato Botelho
			do_as_unbound_user("reload");
599 751533a2 Phil Davis
		}
600 fe9d4894 Renato Botelho
		break;
601
	case "dump_cache":
602
		// Dump Unbound's Cache
603 751533a2 Phil Davis
		if ($config['unbound']['dumpcache'] == "on") {
604 fe9d4894 Renato Botelho
			do_as_unbound_user("dump_cache");
605 751533a2 Phil Davis
		}
606 fe9d4894 Renato Botelho
		break;
607
	case "restore_cache":
608
		// Restore Unbound's Cache
609
		if ((is_service_running("unbound")) && ($config['unbound']['dumpcache'] == "on")) {
610 751533a2 Phil Davis
			if (file_exists($cache_dumpfile) && filesize($cache_dumpfile) > 0) {
611 fe9d4894 Renato Botelho
				do_as_unbound_user("load_cache < /var/tmp/unbound_cache");
612 751533a2 Phil Davis
			}
613 fe9d4894 Renato Botelho
		}
614
		break;
615
	default:
616
		break;
617
618
	}
619 56a87b19 Warren Baker
}
620
621
// Generation of Unbound statistics
622
function unbound_statistics() {
623 fe9d4894 Renato Botelho
	global $config;
624
625
	if ($config['stats'] == "on") {
626
		$stats_interval = $config['unbound']['stats_interval'];
627
		$cumulative_stats = $config['cumulative_stats'];
628 751533a2 Phil Davis
		if ($config['extended_stats'] == "on") {
629 fe9d4894 Renato Botelho
			$extended_stats = "yes";
630 751533a2 Phil Davis
		} else {
631 fe9d4894 Renato Botelho
			$extended_stats = "no";
632 751533a2 Phil Davis
		}
633 fe9d4894 Renato Botelho
	} else {
634
		$stats_interval = "0";
635
		$cumulative_stats = "no";
636
		$extended_stats = "no";
637
	}
638
	/* XXX To do - add RRD graphs */
639
	$stats = <<<EOF
640 56a87b19 Warren Baker
# Unbound Statistics
641
statistics-interval: {$stats_interval}
642
extended-statistics: yes
643
statistics-cumulative: yes
644
645
EOF;
646
647 fe9d4894 Renato Botelho
	return $stats;
648 56a87b19 Warren Baker
}
649
650 8fccab67 Warren Baker
// Unbound Access lists
651 1548bd35 Phil Davis
function unbound_acls_config($cfgsubdir = "") {
652 fe9d4894 Renato Botelho
	global $g, $config;
653
654 f8f5ba1a Chris Buechler
	if (!isset($config['unbound']['disable_auto_added_access_control'])) {
655
		$aclcfg = "access-control: 127.0.0.1/32 allow\n";
656
		$aclcfg .= "access-control: ::1 allow\n";
657
		// Add our networks for active interfaces including localhost
658 8c2a5a73 Phil Davis
		if (!empty($config['unbound']['active_interface'])) {
659 f8f5ba1a Chris Buechler
			$active_interfaces = array_flip(explode(",", $config['unbound']['active_interface']));
660 751533a2 Phil Davis
			if (in_array("all", $active_interfaces)) {
661 80075b9e Chris Buechler
				$active_interfaces = get_configured_interface_with_descr();
662 751533a2 Phil Davis
			}
663
		} else {
664 f8f5ba1a Chris Buechler
			$active_interfaces = get_configured_interface_with_descr();
665 751533a2 Phil Davis
		}
666
667 f8f5ba1a Chris Buechler
		$bindints = "";
668 751533a2 Phil Davis
		foreach ($active_interfaces as $ubif => $ifdesc) {
669 f8f5ba1a Chris Buechler
			$ifip = get_interface_ip($ubif);
670
			if (is_ipaddrv4($ifip)) {
671
				// IPv4 is handled via NAT networks below
672
			}
673
			$ifip = get_interface_ipv6($ubif);
674
			if (is_ipaddrv6($ifip)) {
675 f302a333 Jean Cyr
				if (!is_linklocal($ifip)) {
676
					$subnet_bits = get_interface_subnetv6($ubif);
677
					$subnet_ip = gen_subnetv6($ifip, $subnet_bits);
678 751533a2 Phil Davis
					// only add LAN-type interfaces
679
					if (!interface_has_gateway($ubif)) {
680 f302a333 Jean Cyr
						$aclcfg .= "access-control: {$subnet_ip}/{$subnet_bits} allow\n";
681 751533a2 Phil Davis
					}
682 f302a333 Jean Cyr
				}
683 f8f5ba1a Chris Buechler
				// add for IPv6 static routes to local networks
684
				// for safety, we include only routes reachable on an interface with no
685 751533a2 Phil Davis
				// gateway specified - read: not an Internet connection.
686 cf08b49e Phil Davis
				$static_routes = get_staticroutes(false, false, true); // Parameter 3 returnenabledroutesonly
687 f8f5ba1a Chris Buechler
				foreach ($static_routes as $route) {
688
					if ((lookup_gateway_interface_by_name($route['gateway']) == $ubif) && !interface_has_gateway($ubif)) {
689
						// route is on this interface, interface doesn't have gateway, add it
690
						$aclcfg .= "access-control: {$route['network']} allow\n";
691
					}
692 e3045c51 Chris Buechler
				}
693
			}
694 fe9d4894 Renato Botelho
		}
695 751533a2 Phil Davis
696 f8f5ba1a Chris Buechler
		// Generate IPv4 access-control entries using the same logic as automatic outbound NAT
697
		if (empty($FilterIflist)) {
698
			filter_generate_optcfg_array();
699
		}
700
		$natnetworks_array = array();
701
		$natnetworks_array = filter_nat_rules_automatic_tonathosts();
702
		foreach ($natnetworks_array as $allowednet) {
703 751533a2 Phil Davis
			$aclcfg .= "access-control: $allowednet allow \n";
704
		}
705 3bdf2a70 Chris Buechler
	}
706 fe9d4894 Renato Botelho
707
	// Configure the custom ACLs
708
	if (is_array($config['unbound']['acls'])) {
709 751533a2 Phil Davis
		foreach ($config['unbound']['acls'] as $unbound_acl) {
710 fe9d4894 Renato Botelho
			$aclcfg .= "#{$unbound_acl['aclname']}\n";
711 751533a2 Phil Davis
			foreach ($unbound_acl['row'] as $network) {
712
				if ($unbound_acl['aclaction'] == "allow snoop") {
713 fe9d4894 Renato Botelho
					$unbound_acl['aclaction'] = "allow_snoop";
714 6a827f69 doktornotor
				} elseif ($unbound_acl['aclaction'] == "deny nonlocal") {
715
					$unbound_acl['aclaction'] = "deny_non_local";
716
				} elseif ($unbound_acl['aclaction'] == "refuse nonlocal") {
717
					$unbound_acl['aclaction'] = "refuse_non_local";
718 751533a2 Phil Davis
				}
719 fe9d4894 Renato Botelho
				$aclcfg .= "access-control: {$network['acl_network']}/{$network['mask']} {$unbound_acl['aclaction']}\n";
720
			}
721
		}
722
	}
723
	// Write out Access list
724 1548bd35 Phil Davis
	create_unbound_chroot_path($cfgsubdir);
725
	file_put_contents("{$g['unbound_chroot_path']}{$cfgsubdir}/access_lists.conf", $aclcfg);
726 58d00e65 Warren Baker
727 8fccab67 Warren Baker
}
728
729 f6248774 Warren Baker
// Generate hosts and reload services
730
function unbound_hosts_generate() {
731 fe9d4894 Renato Botelho
	// Generate our hosts file
732
	unbound_add_host_entries();
733 f6248774 Warren Baker
734 fe9d4894 Renato Botelho
	// Reload our service to read the updates
735
	unbound_control("reload");
736 f6248774 Warren Baker
}
737
738 9a83872f NOYB
// Array of valid unbound local zone types
739
function unbound_local_zone_types() {
740
	return array(
741
		"deny" => gettext("Deny"),
742
		"refuse" => gettext("Refuse"),
743
		"static" => gettext("Static"),
744
		"transparent" => gettext("Transparent"),
745
		"typetransparent" => gettext("Type Transparent"),
746
		"redirect" => gettext("Redirect"),
747
		"inform" => gettext("Inform"),
748
		"inform_deny" => gettext("Inform Deny"),
749
		"nodefault" => gettext("No Default")
750
	);
751
}
752
753 3f0c20c3 Renato Botelho
?>