pfSense

<?php

/*

	part of the pfSense project (https://www.pfsense.org)

	Redistribution and use in source and binary forms, with or without

	modification, are permitted provided that the following conditions are met:

	1. Redistributions of source code must retain the above copyright notice,

	   this list of conditions and the following disclaimer.

	2. 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.

	THIS SOFTWARE IS PROVIDED ``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

	AUTHOR 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.

	pfSense_BUILDER_BINARIES:   /usr/local/sbin/unbound-control    /usr/local/sbin/unbound-control-setup

/* include all configuration functions */

require_once("config.inc");

require_once("functions.inc");

require_once("shaper.inc");

	global $config, $g;

	// Configure chroot

	if (!is_dir($g['unbound_chroot_path'])) {

		mkdir($g['unbound_chroot_path']);

		chown($g['unbound_chroot_path'], "unbound");

		chgrp($g['unbound_chroot_path'], "unbound");

	}

}

function unbound_optimization() {

	$optimization_settings = array();

	/* 

	 * Set the number of threads equal to number of CPUs.

	 * Use 1 to disable threading, if for some reason this sysctl fails.

	 */

	$numprocs = intval(get_single_sysctl('kern.smp.cpus'));

	} else {

	}

	// Slabs to help reduce lock contention.

	$optimization['rrset_cache_slabs'] = "rrset-cache-slabs: {$optimize_num}";

	$optimization['infra_cache_slabs'] = "infra-cache-slabs: {$optimize_num}";

	$optimization['key_cache_slabs'] = "key-cache-slabs: {$optimize_num}";

	/*

	 * Larger socket buffer for busy servers

	 * Check that it is set to 4MB (by default the OS has it configured to 4MB)

	 */

		foreach ($config['sysctl']['item'] as $tunable) {

			if ($tunable['tunable'] == 'kern.ipc.maxsockbuf') {

					// Limit to 32MB, users might set maxsockbuf very high for other reasons.

	}

	// Safety check in case kern.ipc.maxsockbuf is not available.

	if (!isset($optimization['so_rcvbuf']))

		$optimization['so_rcvbuf'] = "#so-rcvbuf: 4m";

	return $optimization;

}

function unbound_generate_config() {

	// Setup optimization

	$optimization = unbound_optimization();

	// Setup DNSSEC support

	if (isset($config['unbound']['dnssec'])) {

		$module_config = "validator iterator";

		$anchor_file = "auto-trust-anchor-file: {$g['unbound_chroot_path']}/root.key";

	} else

		$module_config = "iterator";

	// Setup DNS Rebinding

	if (!isset($config['system']['webgui']['nodnsrebindcheck'])) {

		// Private-addresses for DNS Rebinding

		$private_addr = <<<EOF

private-address: 10.0.0.0/8

private-address: 172.16.0.0/12

private-address: fd00::/8

private-address: fe80::/10

EOF;

	// Determine interfaces to run on

	$bindints = "";

	if (!empty($config['unbound']['active_interface'])) {

		$active_interfaces = explode(",", $config['unbound']['active_interface']);

			$bindints .= "interface: 0.0.0.0\n";

			$bindints .= "interface: ::0\n";

			foreach($active_interfaces as $ubif) {

					//$bindints .= "interface: $ubif\n";  -- until redmine #4062 is fixed, then uncomment this. 

				} else {

					$intip = get_interface_ip($ubif);

					if (is_ipaddrv4($intip))

						$bindints .= "interface: $intip\n";

					$intip = get_interface_ipv6($ubif);

					if (is_ipaddrv6($intip))

				}

	} else {

		$bindints .= "interface: 0.0.0.0\n";

		$bindints .= "interface: ::0\n";

	}

	// Determine interfaces to run on

	$outgoingints = "";

	if (!empty($config['unbound']['outgoing_interface'])) {

		$outgoingints = "# Outgoing interfaces to be used\n";

		$outgoing_interfaces = explode(",", $config['unbound']['outgoing_interface']);

		foreach($outgoing_interfaces as $outif) {

			$outip = get_interface_ip($outif);

			if (!is_null($outip))

				$outgoingints .= "outgoing-interface: $outip\n";

			$outip = get_interface_ipv6($outif);

			if (!is_null($outip))

				$outgoingints .= "outgoing-interface: $outip\n";

		}

	}

	// Allow DNS Rebind for forwarded domains

		if (!isset($config['system']['webgui']['nodnsrebindcheck'])) {

			$private_domains = "# Set private domains in case authoritative name server returns a Private IP address\n";

			$private_domains .= unbound_add_domain_overrides("private");

		}

		$reverse_zones .= unbound_add_domain_overrides("reverse");

	// Configure static Host entries

	unbound_add_host_entries();

	// Configure Domain Overrides

	unbound_add_domain_overrides();

	// Configure Unbound statistics

	$statistics = unbound_statistics();

	// Configure Unbound access-lists

	unbound_acls_config();

	// Add custom Unbound options

	if ($config['unbound']['custom_options']) {

	// Server configuration variables

	$port = (is_port($config['unbound']['port'])) ? $config['unbound']['port'] : "53";

	$hide_version = isset($config['unbound']['hideversion']) ? "yes" : "no";

	$harden_glue = isset($config['unbound']['hardenglue']) ? "yes" : "no";

	$harden_dnssec_stripped = isset($config['unbound']['dnssecstripped']) ? "yes" : "no";

	$prefetch = isset($config['unbound']['prefetch']) ? "yes" : "no";

	$prefetch_key = isset($config['unbound']['prefetchkey']) ? "yes" : "no";

	$incoming_num_tcp = (!empty($config['unbound']['incoming_num_tcp'])) ? $config['unbound']['incoming_num_tcp'] : "10";

	$edns_buffer_size = (!empty($config['unbound']['edns_buffer_size'])) ? $config['unbound']['edns_buffer_size'] : "4096";

	$num_queries_per_thread = (!empty($config['unbound']['num_queries_per_thread'])) ? $config['unbound']['num_queries_per_thread'] : "4096";

	$jostle_timeout = (!empty($config['unbound']['jostle_timeout'])) ? $config['unbound']['jostle_timeout'] : "200";

	$cache_max_ttl = (!empty($config['unbound']['cache_max_ttl'])) ? $config['unbound']['cache_max_ttl'] : "86400";

	$cache_min_ttl = (!empty($config['unbound']['cache_min_ttl'])) ? $config['unbound']['cache_min_ttl'] : "0";

	$infra_host_ttl = (!empty($config['unbound']['infra_host_ttl'])) ? $config['unbound']['infra_host_ttl'] : "900";

	$infra_cache_numhosts = (!empty($config['unbound']['infra_cache_numhosts'])) ? $config['unbound']['infra_cache_numhosts'] : "10000";

	$unwanted_reply_threshold = (!empty($config['unbound']['unwanted_reply_threshold'])) ? $config['unbound']['unwanted_reply_threshold'] : "0";

		$unwanted_reply_threshold = "0";

	$msg_cache_size = (!empty($config['unbound']['msgcachesize'])) ? $config['unbound']['msgcachesize'] : "4";

	$verbosity = isset($config['unbound']['log_verbosity']) ? $config['unbound']['log_verbosity'] : 1;

	// Set up forwarding if it configured

	if (isset($config['unbound']['forwarding'])) {

		$dnsservers = array();

		if (isset($config['system']['dnsallowoverride'])) {

			$ns = array_unique(get_nameservers());

			foreach($ns as $nameserver) {

				if ($nameserver)

					$dnsservers[] = $nameserver;

			}

		} else {

			$ns = array_unique(get_dns_servers());

			foreach($ns as $nameserver) {

				if ($nameserver)

					$dnsservers[] = $nameserver;

			}

		}

		if (!empty($dnsservers)) {

			$forward_conf .=<<<EOD

EOD;

				$forward_conf .= "\tforward-addr: $dnsserver\n";

		}

	} else

		$forward_conf = "";

	$rrset_cache_size = $msg_cache_size * 2;

# Unbound Configuration

##########################

##

# Server configuration

##

server:

username: "unbound"

use-syslog: yes

hide-version: {$hide_version}

harden-glue: {$harden_glue}

do-ip6: yes

do-udp: yes

do-tcp: yes

do-daemonize: yes

module-config: "{$module_config}"

num-queries-per-thread: {$num_queries_per_thread}

jostle-timeout: {$jostle_timeout}

infra-host-ttl: {$infra_host_ttl}

infra-cache-numhosts: {$infra_cache_numhosts}

outgoing-num-tcp: {$outgoing_num_tcp}

incoming-num-tcp: {$incoming_num_tcp}

edns-buffer-size: {$edns_buffer_size}

cache-min-ttl: {$cache_min_ttl}

msg-cache-size: {$msg_cache_size}m

{$optimization['msg_cache_slabs']}

{$optimization['rrset_cache_slabs']}

{$optimization['infra_cache_slabs']}

{$optimization['key_cache_slabs']}

{$anchor_file}

prefetch-key: {$prefetch_key}

{$statistics}

# Interface IP(s) to bind to

# DNS Rebinding

{$private_addr}

{$private_domains}

include: {$g['unbound_chroot_path']}/access_lists.conf

include: {$g['unbound_chroot_path']}/dhcpleases_entries.conf

###

# Remote Control Config

###

EOD;

function unbound_remote_control_setup() {

		$remotcfg = <<<EOF

	control-interface: 127.0.0.1

	control-port: 953

	server-key-file: "{$g['unbound_chroot_path']}/unbound_server.key"

	server-cert-file: "{$g['unbound_chroot_path']}/unbound_server.pem"

	control-key-file: "{$g['unbound_chroot_path']}/unbound_control.key"

	control-cert-file: "{$g['unbound_chroot_path']}/unbound_control.pem"

		do_as_unbound_user("unbound-control-setup");

	 * XXX - to convert to an unbound C library which reads /etc/hosts automatically

	 */

	$etc_hosts = array();

	foreach (file('/etc/hosts') as $line) {

			break;

		$d = preg_split('/\s+/', $line, -1, PREG_SPLIT_NO_EMPTY);

			continue;

		$fqdn = array_shift($d);

		$name = array_shift($d);

		if (!empty($fqdn) && $fqdn != "empty") {

			if (!empty($name) && $name != "empty")

				array_push($etc_hosts, array(ipaddr => "$ip", fqdn => "$fqdn", name => "$name"));

			else

				array_push($etc_hosts, array(ipaddr => "$ip", fqdn => "$fqdn"));

	}

	return $etc_hosts;

function sync_unbound_service() {

	// Configure our Unbound service

	do_as_unbound_user("unbound-anchor");

	unbound_remote_control_setup();

	unbound_generate_config();

	do_as_unbound_user("start");

	require_once("service-utils.inc");

	if (is_service_running("unbound"))

		do_as_unbound_user("restore_cache");

}

function unbound_acl_id_used($id) {

		foreach($config['unbound']['acls'] as & $acls)

			if ($id == $acls['aclid'])

				return true;

function unbound_get_next_id() {

	while(unbound_acl_id_used($aclid))

		$aclid++;

	return $aclid;

// Execute commands as the user unbound

function do_as_unbound_user($cmd) {

	switch ($cmd) {

	case "start":

	case "stop":

		mwexec("echo '/usr/local/sbin/unbound-control reload' | /usr/bin/su -m unbound", true);

		break;

	case "unbound-control-setup":

	default:

		break;

	}

	$domains = $config['unbound']['domainoverrides'];

	$sorted_domains = msort($domains, "domain");

	$result = array();

	foreach($sorted_domains as $domain) {

		$domain_key = current($domain);

		if (!isset($result[$domain_key]))

			$result[$domain_key] = array();

		$result[$domain_key][] = $domain['ip'];

	}

	// Domain overrides that have multiple entries need multiple stub-addr: added

	$domain_entries = "";

	foreach($result as $domain=>$ips) {

			$domain_entries .= "domain-insecure: \"$domain\"\n";

			if ((substr($domain,-14) == ".in-addr.arpa.") || (substr($domain,-13) == ".in-addr.arpa")) {

				$domain_entries .= "local-zone: \"$domain\" typetransparent\n";

			}

			$domain_entries .= "stub-zone:\n";

			$domain_entries .= "\tname: \"$domain\"\n";

			foreach($ips as $ip)

				$domain_entries .= "\tstub-addr: $ip\n";

			$domain_entries .= "\tstub-prime: no\n";

		}

	}

		create_unbound_chroot_path();

function unbound_add_host_entries() {

	$unbound_entries = "local-zone: \"{$config['system']['domain']}\" transparent\n";

		if (is_ipaddrv4($host['ipaddr']))

			$type = 'A';

		else if (is_ipaddrv6($host['ipaddr']))

			$type = 'AAAA';

		else

			continue;

			$unbound_entries .= "local-data-ptr: \"{$host['ipaddr']} {$host['fqdn']}\"\n";

			$added_ptr[$host['ip']] = true;

		}

		if (isset($host['name']))

			$unbound_entries .= "local-data: \"{$host['name']} {$type} {$host['ipaddr']}\"\n";

	// Write out entries

	/* dhcpleases will write to this config file, make sure it exists */

	@touch("{$g['unbound_chroot_path']}/dhcpleases_entries.conf");

	$cache_dumpfile = "/var/tmp/unbound_cache";

	switch ($action) {

	case "start":

		// Start Unbound

		if ($config['unbound']['enable'] == "on") {

			if (!is_service_running("unbound"))

				do_as_unbound_user("start");

		}

		break;

	case "stop":

		if ($config['unbound']['enable'] == "on")

			do_as_unbound_user("stop");

		break;

	case "reload":

		if ($config['unbound']['enable'] == "on")

			do_as_unbound_user("reload");

		break;

	case "dump_cache":

		// Dump Unbound's Cache

		if ($config['unbound']['dumpcache'] == "on")

			do_as_unbound_user("dump_cache");

		break;

	case "restore_cache":

		// Restore Unbound's Cache

		if ((is_service_running("unbound")) && ($config['unbound']['dumpcache'] == "on")) {

			if (file_exists($cache_dumpfile) && filesize($cache_dumpfile) > 0)

				do_as_unbound_user("load_cache < /var/tmp/unbound_cache");

		}

		break;

	default:

		break;

	}

// Generation of Unbound statistics

function unbound_statistics() {

	if ($config['stats'] == "on") {

		$stats_interval = $config['unbound']['stats_interval'];

		$cumulative_stats = $config['cumulative_stats'];

		if ($config['extended_stats'] == "on")

			$extended_stats = "yes";

		else

			$extended_stats = "no";

	} else {

		$stats_interval = "0";

		$cumulative_stats = "no";

		$extended_stats = "no";

	}

	/* XXX To do - add RRD graphs */

	$stats = <<<EOF

statistics-interval: {$stats_interval}

extended-statistics: yes

statistics-cumulative: yes

EOF;

function unbound_acls_config() {

		$aclcfg = "access-control: 127.0.0.1/32 allow\n";

		$aclcfg .= "access-control: ::1 allow\n";

		// Add our networks for active interfaces including localhost

		$bindints = "";

		foreach($active_interfaces as $ubif => $ifdesc) {

			$ifip = get_interface_ip($ubif);

			if (is_ipaddrv4($ifip)) {

				// IPv4 is handled via NAT networks below

			}

			$ifip = get_interface_ipv6($ubif);

			if (is_ipaddrv6($ifip)) {

					$subnet_bits = get_interface_subnetv6($ubif);

					$subnet_ip = gen_subnetv6($ifip, $subnet_bits);

					// only add LAN-type interfaces 

					if (!interface_has_gateway($ubif))

						$aclcfg .= "access-control: {$subnet_ip}/{$subnet_bits} allow\n";

				}

				// for safety, we include only routes reachable on an interface with no

				// gateway specified - read: not an Internet connection. 

				$static_routes = get_staticroutes();

				foreach ($static_routes as $route) {

					if ((lookup_gateway_interface_by_name($route['gateway']) == $ubif) && !interface_has_gateway($ubif)) {

						// route is on this interface, interface doesn't have gateway, add it

						$aclcfg .= "access-control: {$route['network']} allow\n";

					}

			}

		// Generate IPv4 access-control entries using the same logic as automatic outbound NAT

		if (empty($FilterIflist)) {

			filter_generate_optcfg_array();

		}

		$natnetworks_array = array();

		$natnetworks_array = filter_nat_rules_automatic_tonathosts();

		foreach ($natnetworks_array as $allowednet) {

			$aclcfg .= "access-control: $allowednet allow \n";	

		}	

	// Configure the custom ACLs

	if (is_array($config['unbound']['acls'])) {

		foreach($config['unbound']['acls'] as $unbound_acl) {

			$aclcfg .= "#{$unbound_acl['aclname']}\n";

			foreach($unbound_acl['row'] as $network) {

				if ($unbound_acl['aclaction'] == "allow snoop")

					$unbound_acl['aclaction'] = "allow_snoop";

				$aclcfg .= "access-control: {$network['acl_network']}/{$network['mask']} {$unbound_acl['aclaction']}\n";

			}

		}

	}

	// Write out Access list

function unbound_hosts_generate() {

	unbound_add_host_entries();

	unbound_control("reload");