[ipfire-2.x.git] / src / initscripts / system / unbound

#!/bin/sh
# Begin $rc_base/init.d/unbound

# Description : Unbound DNS resolver boot script for IPfire
# Author      : Marcel Lorenz <marcel.lorenz@ipfire.org>

. /etc/sysconfig/rc
. ${rc_functions}

TEST_DOMAIN="ipfire.org"

# This domain will never validate
TEST_DOMAIN_FAIL="dnssec-failed.org"

INSECURE_ZONES=
USE_FORWARDERS=1

# Cache any local zones for 60 seconds
LOCAL_TTL=60

# EDNS buffer size
EDNS_DEFAULT_BUFFER_SIZE=4096

# Load optional configuration
[ -e "/etc/sysconfig/unbound" ] && . /etc/sysconfig/unbound

ip_address_revptr() {
	local addr=${1}

	local a1 a2 a3 a4
	IFS=. read -r a1 a2 a3 a4 <<< ${addr}

	echo "${a4}.${a3}.${a2}.${a1}.in-addr.arpa"
}

read_name_servers() {
	local i
	for i in 1 2; do
		echo "$(</var/ipfire/red/dns${i})"
	done 2>/dev/null | xargs echo
}

config_header() {
	echo "# This file is automatically generated and any changes"
	echo "# will be overwritten. DO NOT EDIT!"
	echo
}

update_forwarders() {
	if [ "${USE_FORWARDERS}" = "1" -a -e "/var/ipfire/red/active" ]; then
		local forwarders
		local broken_forwarders

		local ns
		for ns in $(read_name_servers); do
			test_name_server ${ns} &>/dev/null
			case "$?" in
				# Only use DNSSEC-validating or DNSSEC-aware name servers
				0|2)
					forwarders="${forwarders} ${ns}"
					;;
				*)
					broken_forwarders="${broken_forwarders} ${ns}"
					;;
			esac
		done

		# Determine EDNS buffer size
		local new_edns_buffer_size=${EDNS_DEFAULT_BUFFER_SIZE}

		for ns in ${forwarders}; do
			local edns_buffer_size=$(ns_determine_edns_buffer_size ${ns})
			if [ -n "${edns_buffer_size}" ]; then
				if [ ${edns_buffer_size} -lt ${new_edns_buffer_size} ]; then
					new_edns_buffer_size=${edns_buffer_size}
				fi
			fi
		done

		if [ ${new_edns_buffer_size} -lt ${EDNS_DEFAULT_BUFFER_SIZE} ]; then
			boot_mesg "EDNS buffer size reduced to ${new_edns_buffer_size}" ${WARNING}
			echo_warning

			unbound-control -q set_option edns-buffer-size: ${new_edns_buffer_size}
		fi

		# Show warning for any broken upstream name servers
		if [ -n "${broken_forwarders}" ]; then
			boot_mesg "Ignoring broken upstream name server(s): ${broken_forwarders:1}" ${WARNING}
			echo_warning
		fi

		if [ -n "${forwarders}" ]; then
			boot_mesg "Configuring upstream name server(s): ${forwarders:1}" ${INFO}
			echo_ok

			# Make sure DNSSEC is activated
			enable_dnssec

			echo "${forwarders}" > /var/ipfire/red/dns
			unbound-control -q forward ${forwarders}
			return 0

		# In case we have found no working forwarders
		else
			# Test if the recursor mode is available
			if can_resolve_root +bufsize=${new_edns_buffer_size}; then
				# Make sure DNSSEC is activated
				enable_dnssec

				boot_mesg "Falling back to recursor mode" ${WARNING}
				echo_warning

			# If not, we set DNSSEC in permissive mode and allow using all recursors
			elif [ -n "${broken_forwarders}" ]; then
				disable_dnssec

				boot_mesg "DNSSEC has been set to permissive mode" ${FAILURE}
				echo_failure

				echo "${broken_forwarders}" > /var/ipfire/red/dns
				unbound-control -q forward ${broken_forwarders}
				return 0
			fi
		fi
	fi

	# If forwarders cannot be used we run in recursor mode
	echo "local recursor" > /var/ipfire/red/dns
	unbound-control -q forward off
}

own_hostname() {
	local hostname=$(hostname -f)
	# 1.1.1.1 is reserved for unused green, skip this
	if [ -n "${GREEN_ADDRESS}" -a "${GREEN_ADDRESS}" != "1.1.1.1" ]; then
		unbound-control -q local_data "${hostname} ${LOCAL_TTL} IN A ${GREEN_ADDRESS}"
	fi

	local address
	for address in ${GREEN_ADDRESS} ${BLUE_ADDRESS} ${ORANGE_ADDRESS}; do
		[ -n "${address}" ] || continue
		[ "${address}" = "1.1.1.1" ] && continue

		address=$(ip_address_revptr ${address})
		unbound-control -q local_data "${address} ${LOCAL_TTL} IN PTR ${hostname}"
	done
}

update_hosts() {
	local enabled address hostname domainname generateptr

	while IFS="," read -r enabled address hostname domainname generateptr; do
		[ "${enabled}" = "on" ] || continue

		# Build FQDN
		local fqdn="${hostname}.${domainname}"

		unbound-control -q local_data "${fqdn} ${LOCAL_TTL} IN A ${address}"

		# Skip reverse resolution if the address equals the GREEN address
		[ "${address}" = "${GREEN_ADDRESS}" ] && continue

		# Skip reverse resolution if user requested not to do so
		[ "${generateptr}" = "off" ] && continue

		# Add RDNS
		address=$(ip_address_revptr ${address})
		unbound-control -q local_data "${address} ${LOCAL_TTL} IN PTR ${fqdn}"
	done < /var/ipfire/main/hosts
}

write_forward_conf() {
	(
		config_header

		local insecure_zones="${INSECURE_ZONES}"

		local enabled zone server servers remark disable_dnssec rest
		while IFS="," read -r enabled zone servers remark disable_dnssec rest; do
			# Line must be enabled.
			[ "${enabled}" = "on" ] || continue

			# Zones that end with .local are commonly used for internal
			# zones and therefore not signed
			case "${zone}" in
				*.local)
					insecure_zones="${insecure_zones} ${zone}"
					;;
				*)
					if [ "${disable_dnssec}" = "on" ]; then
						insecure_zones="${insecure_zones} ${zone}"
					fi
					;;
			esac

			# Reverse-lookup zones must be stubs
			case "${zone}" in
				*.in-addr.arpa)
					echo "stub-zone:"
					echo "	name: ${zone}"
					for server in ${servers//|/ }; do
						if [[ ${server} =~ ^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
							echo "	stub-addr: ${server}"
						else
							echo "	stub-host: ${server}"
						fi
					done
					echo
					echo "server:"
					echo "	local-zone: \"${zone}\" transparent"
					echo
					;;
				*)
					echo "forward-zone:"
					echo "	name: ${zone}"
					for server in ${servers//|/ }; do
						if [[ ${server} =~ ^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
							echo "	forward-addr: ${server}"
						else
							echo "	forward-host: ${server}"
						fi
					done
					echo
					;;
			esac
		done < /var/ipfire/dnsforward/config

		if [ -n "${insecure_zones}" ]; then
			echo "server:"

			for zone in ${insecure_zones}; do
				echo "	domain-insecure: ${zone}"
			done
		fi
	) > /etc/unbound/forward.conf
}

write_tuning_conf() {
	# https://www.unbound.net/documentation/howto_optimise.html

	# Determine number of online processors
	local processors=$(getconf _NPROCESSORS_ONLN)

	# Determine number of slabs
	local slabs=1
	while [ ${slabs} -lt ${processors} ]; do
		slabs=$(( ${slabs} * 2 ))
	done

	# Determine amount of system memory
	local mem=$(get_memory_amount)

	# In the worst case scenario, unbound can use double the
	# amount of memory allocated to a cache due to malloc overhead

	# Even larger systems with more than 8GB of RAM
	if [ ${mem} -ge 8192 ]; then
		mem=1024

	# Extra large systems with more than 4GB of RAM
	elif [ ${mem} -ge 4096 ]; then
		mem=512

	# Large systems with more than 2GB of RAM
	elif [ ${mem} -ge 2048 ]; then
		mem=256

	# Medium systems with more than 1GB of RAM
	elif [ ${mem} -ge 1024 ]; then
		mem=128

	# Small systems with less than 256MB of RAM
	elif [ ${mem} -le 256 ]; then
		mem=16

	# Everything else
	else
		mem=64
	fi

	(
		config_header

		# We run one thread per processor
		echo "num-threads: ${processors}"
		echo "so-reuseport: yes"

		# Adjust number of slabs
		echo "infra-cache-slabs: ${slabs}"
		echo "key-cache-slabs: ${slabs}"
		echo "msg-cache-slabs: ${slabs}"
		echo "rrset-cache-slabs: ${slabs}"

		# Slice up the cache
		echo "rrset-cache-size: $(( ${mem} / 2 ))m"
		echo "msg-cache-size: $(( ${mem} / 4 ))m"
		echo "key-cache-size: $(( ${mem} / 4 ))m"

		# Increase parallel queries
		echo "outgoing-range: 8192"
		echo "num-queries-per-thread: 4096"

		# Use larger send/receive buffers
		echo "so-sndbuf: 4m"
		echo "so-rcvbuf: 4m"
	) > /etc/unbound/tuning.conf
}

get_memory_amount() {
	local key val unit

	while read -r key val unit; do
		case "${key}" in
			MemTotal:*)
				# Convert to MB
				echo "$(( ${val} / 1024 ))"
				break
				;;
		esac
	done < /proc/meminfo
}

test_name_server() {
	local ns=${1}
	local args

	# Return codes:
	# 0	DNSSEC validating
	# 1	Error: unreachable, etc.
	# 2	DNSSEC aware
	# 3	NOT DNSSEC-aware

	# Exit when the server is not reachable
	ns_is_online ${ns} || return 1

	# Determine the maximum edns buffer size that works
	local edns_buffer_size=$(ns_determine_edns_buffer_size ${ns})
	if [ -n "${edns_buffer_size}" ]; then
		args="${args} +bufsize=${edns_buffer_size}"
	fi

	local errors
	for rr in DNSKEY DS RRSIG; do
		if ! ns_forwards_${rr} ${ns} ${args}; then
			errors="${errors} ${rr}"
		fi
	done

	if [ -n "${errors}" ]; then
		echo >&2 "Unable to retrieve the following resource records from ${ns}: ${errors:1}"
		return 3
	fi

	if ns_is_validating ${ns} ${args}; then
		# Return 0 if validating
		return 0
	else
		# Is DNSSEC-aware
		return 2
	fi
}

# Sends an A query to the nameserver w/o DNSSEC
ns_is_online() {
	local ns=${1}
	shift

	dig @${ns} +nodnssec A ${TEST_DOMAIN} $@ >/dev/null
}

# Resolving ${TEST_DOMAIN_FAIL} will fail if the nameserver is validating
ns_is_validating() {
	local ns=${1}
	shift

	if ! dig @${ns} A ${TEST_DOMAIN_FAIL} $@ | grep -q SERVFAIL; then
		return 1
	else
		# Determine if NS replies with "ad" data flag if DNSSEC enabled
		dig @${ns} +dnssec SOA ${TEST_DOMAIN} $@ | awk -F: '/\;\;\ flags\:/ { s=1; if (/\ ad/) s=0; exit s }'
	fi
}

# Checks if we can retrieve the DNSKEY for this domain.
# dig will print the SOA if nothing was found
ns_forwards_DNSKEY() {
	local ns=${1}
	shift

	dig @${ns} DNSKEY ${TEST_DOMAIN} $@ | grep -qv SOA
}

ns_forwards_DS() {
	local ns=${1}
	shift

	dig @${ns} DS ${TEST_DOMAIN} $@ | grep -qv SOA
}

ns_forwards_RRSIG() {
	local ns=${1}
	shift

	dig @${ns} +dnssec A ${TEST_DOMAIN} $@ | grep -q RRSIG
}

ns_supports_tcp() {
	local ns=${1}
	shift

	dig @${ns} +tcp A ${TEST_DOMAIN} $@ >/dev/null || return 1
}

ns_determine_edns_buffer_size() {
	local ns=${1}
	shift

	local b
	for b in 4096 2048 1500 1480 1464 1400 1280 512; do
		if dig @${ns} +dnssec +bufsize=${b} A ${TEST_DOMAIN} $@ >/dev/null; then
			echo "${b}"
			return 0
		fi
	done

	return 1
}

get_root_nameservers() {
	while read -r hostname ttl record address; do
		# Searching for A records
		[ "${record}" = "A" ] || continue

		echo "${address}"
	done < /etc/unbound/root.hints
}

can_resolve_root() {
	local ns
	for ns in $(get_root_nameservers); do
		if dig @${ns} +dnssec SOA . $@ >/dev/null; then
			return 0
		fi
	done

	# none of the servers was reachable
	return 1
}

enable_dnssec() {
	local status=$(unbound-control get_option val-permissive-mode)

	# Log DNSSEC status
	echo "on" > /var/ipfire/red/dnssec-status

	# Don't do anything if DNSSEC is already activated
	[ "${status}" = "no" ] && return 0

	# Activate DNSSEC and flush cache with any stale and unvalidated data
	unbound-control -q set_option val-permissive-mode: no
	unbound-control -q flush_zone .
}

disable_dnssec() {
	# Log DNSSEC status
	echo "off" > /var/ipfire/red/dnssec-status

	unbound-control -q set_option val-permissive-mode: yes
}

fix_time_if_dns_fail() {
	# If DNS still not work try to init ntp with
	# hardcoded ntp.ipfire.org (81.3.27.46)
	if [ -e /var/ipfire/red/active ]; then
		host 0.ipfire.pool.ntp.org > /dev/null 2>&1
		if [ "${?}" != "0" ]; then
			boot_mesg "DNS still not functioning... Trying to sync time with ntp.ipfire.org (81.3.27.46)..."
			loadproc /usr/local/bin/settime 81.3.27.46
		fi
	fi
}

case "$1" in
	start)
		# Print a nicer messagen when unbound is already running
		if pidofproc -s unbound; then
			statusproc /usr/sbin/unbound
			exit 0
		fi

		eval $(/usr/local/bin/readhash /var/ipfire/ethernet/settings)

		# Update configuration files
		write_tuning_conf
		write_forward_conf

		boot_mesg "Starting Unbound DNS Proxy..."
		loadproc /usr/sbin/unbound || exit $?

		# Make own hostname resolveable
		own_hostname

		# Update any known forwarding name servers
		update_forwarders

		# Update hosts
		update_hosts

		fix_time_if_dns_fail
		;;

	stop)
		boot_mesg "Stopping Unbound DNS Proxy..."
		killproc /usr/sbin/unbound
		;;

	restart)
		$0 stop
		sleep 1
		$0 start
		;;

	status)
		statusproc /usr/sbin/unbound
		;;

	update-forwarders)
		# Do not try updating forwarders when unbound is not running
		if ! pgrep unbound &>/dev/null; then
			exit 0
		fi

		update_forwarders

		unbound-control flush_negative > /dev/null
		unbound-control flush_bogus > /dev/null

		fix_time_if_dns_fail
		;;

	test-name-server)
		ns=${2}

		test_name_server ${ns}
		ret=${?}

		case "${ret}" in
			0)
				echo "${ns} is validating"
				;;
			2)
				echo "${ns} is DNSSEC-aware"
				;;
			3)
				echo "${ns} is NOT DNSSEC-aware"
				;;
			*)
				echo "Test failed for an unknown reason"
				exit ${ret}
				;;
		esac

		if ns_supports_tcp ${ns}; then
			echo "${ns} supports TCP fallback"
		else
			echo "${ns} does not support TCP fallback"
		fi

		edns_buffer_size=$(ns_determine_edns_buffer_size ${ns})
		if [ -n "${edns_buffer_size}" ]; then
			echo "EDNS buffer size for ${ns}: ${edns_buffer_size}"
		fi

		exit ${ret}
		;;

	*)
		echo "Usage: $0 {start|stop|restart|status|update-forwarders|test-name-server}"
		exit 1
		;;
esac

# End $rc_base/init.d/unbound
Commit	Line	Data
d0e5f71f ML	1	#!/bin/sh
	2	# Begin $rc_base/init.d/unbound
	3
	4	# Description : Unbound DNS resolver boot script for IPfire
	5	# Author : Marcel Lorenz <marcel.lorenz@ipfire.org>
d0e5f71f ML	6
	7	. /etc/sysconfig/rc
	8	. ${rc_functions}
	9
b29c97b1 AF	10	TEST_DOMAIN="ipfire.org"
	11
	12	# This domain will never validate
	13	TEST_DOMAIN_FAIL="dnssec-failed.org"
	14
7ebc0a16	15	INSECURE_ZONES=
b8f5eda8	16	USE_FORWARDERS=1
d0e5f71f	17
36792be6 MT	18	# Cache any local zones for 60 seconds
	19	LOCAL_TTL=60
	20
b2f96a94 MT	21	# EDNS buffer size
	22	EDNS_DEFAULT_BUFFER_SIZE=4096
	23
b8f5eda8 MT	24	# Load optional configuration
b8f5eda8 MT	25	[ -e "/etc/sysconfig/unbound" ] && . /etc/sysconfig/unbound
d0e5f71f	26
f75c279b AF	27	ip_address_revptr() {
	28	local addr=${1}
	29
	30	local a1 a2 a3 a4
	31	IFS=. read -r a1 a2 a3 a4 <<< ${addr}
	32
	33	echo "${a4}.${a3}.${a2}.${a1}.in-addr.arpa"
	34	}
	35
b8f5eda8 MT	36	read_name_servers() {
	37	local i
	38	for i in 1 2; do
	39	echo "$(</var/ipfire/red/dns${i})"
682a6b2d	40	done 2>/dev/null \| xargs echo
b8f5eda8 MT	41	}
	42
	43	config_header() {
	44	echo "# This file is automatically generated and any changes"
	45	echo "# will be overwritten. DO NOT EDIT!"
	46	echo
	47	}
	48
	49	update_forwarders() {
b29c97b1 AF	50	if [ "${USE_FORWARDERS}" = "1" -a -e "/var/ipfire/red/active" ]; then
	51	local forwarders
	52	local broken_forwarders
	53
	54	local ns
	55	for ns in $(read_name_servers); do
	56	test_name_server ${ns} &>/dev/null
	57	case "$?" in
	58	# Only use DNSSEC-validating or DNSSEC-aware name servers
	59	0\|2)
	60	forwarders="${forwarders} ${ns}"
	61	;;
	62	*)
	63	broken_forwarders="${broken_forwarders} ${ns}"
	64	;;
	65	esac
	66	done
	67
8f3034d0	68	# Determine EDNS buffer size
b2f96a94	69	local new_edns_buffer_size=${EDNS_DEFAULT_BUFFER_SIZE}
8f3034d0	70
b2f96a94 MT	71	for ns in ${forwarders}; do
	72	local edns_buffer_size=$(ns_determine_edns_buffer_size ${ns})
	73	if [ -n "${edns_buffer_size}" ]; then
	74	if [ ${edns_buffer_size} -lt ${new_edns_buffer_size} ]; then
	75	new_edns_buffer_size=${edns_buffer_size}
8f3034d0	76	fi
b2f96a94 MT	77	fi
	78	done
	79
	80	if [ ${new_edns_buffer_size} -lt ${EDNS_DEFAULT_BUFFER_SIZE} ]; then
	81	boot_mesg "EDNS buffer size reduced to ${new_edns_buffer_size}" ${WARNING}
	82	echo_warning
8f3034d0 MT	83
	84	unbound-control -q set_option edns-buffer-size: ${new_edns_buffer_size}
	85	fi
	86
b29c97b1 AF	87	# Show warning for any broken upstream name servers
	88	if [ -n "${broken_forwarders}" ]; then
	89	boot_mesg "Ignoring broken upstream name server(s): ${broken_forwarders:1}" ${WARNING}
	90	echo_warning
	91	fi
b8f5eda8	92
e432689a	93	if [ -n "${forwarders}" ]; then
b29c97b1 AF	94	boot_mesg "Configuring upstream name server(s): ${forwarders:1}" ${INFO}
b29c97b1 AF	95	echo_ok
b8f5eda8	96
e432689a MT	97	# Make sure DNSSEC is activated
	98	enable_dnssec
	99
e24d6112	100	echo "${forwarders}" > /var/ipfire/red/dns
b29c97b1 AF	101	unbound-control -q forward ${forwarders}
b29c97b1 AF	102	return 0
e432689a MT	103
	104	# In case we have found no working forwarders
	105	else
	106	# Test if the recursor mode is available
	107	if can_resolve_root +bufsize=${new_edns_buffer_size}; then
	108	# Make sure DNSSEC is activated
	109	enable_dnssec
	110
	111	boot_mesg "Falling back to recursor mode" ${WARNING}
	112	echo_warning
	113
	114	# If not, we set DNSSEC in permissive mode and allow using all recursors
	115	elif [ -n "${broken_forwarders}" ]; then
	116	disable_dnssec
	117
	118	boot_mesg "DNSSEC has been set to permissive mode" ${FAILURE}
	119	echo_failure
	120
	121	echo "${broken_forwarders}" > /var/ipfire/red/dns
	122	unbound-control -q forward ${broken_forwarders}
	123	return 0
	124	fi
b29c97b1	125	fi
b8f5eda8	126	fi
b29c97b1 AF	127
b29c97b1 AF	128	# If forwarders cannot be used we run in recursor mode
e24d6112	129	echo "local recursor" > /var/ipfire/red/dns
b29c97b1	130	unbound-control -q forward off
b8f5eda8 MT	131	}
b8f5eda8 MT	132
f75c279b AF	133	own_hostname() {
f75c279b AF	134	local hostname=$(hostname -f)
0d7ca700	135	# 1.1.1.1 is reserved for unused green, skip this
f75c279b AF	136	if [ -n "${GREEN_ADDRESS}" -a "${GREEN_ADDRESS}" != "1.1.1.1" ]; then
	137	unbound-control -q local_data "${hostname} ${LOCAL_TTL} IN A ${GREEN_ADDRESS}"
	138	fi
	139
	140	local address
	141	for address in ${GREEN_ADDRESS} ${BLUE_ADDRESS} ${ORANGE_ADDRESS}; do
	142	[ -n "${address}" ] \|\| continue
	143	[ "${address}" = "1.1.1.1" ] && continue
	144
	145	address=$(ip_address_revptr ${address})
	146	unbound-control -q local_data "${address} ${LOCAL_TTL} IN PTR ${hostname}"
	147	done
	148	}
	149
36792be6	150	update_hosts() {
6874a576	151	local enabled address hostname domainname generateptr
36792be6	152
6874a576	153	while IFS="," read -r enabled address hostname domainname generateptr; do
36792be6 MT	154	[ "${enabled}" = "on" ] \|\| continue
	155
	156	# Build FQDN
	157	local fqdn="${hostname}.${domainname}"
	158
	159	unbound-control -q local_data "${fqdn} ${LOCAL_TTL} IN A ${address}"
f75c279b	160
868d2a1f MT	161	# Skip reverse resolution if the address equals the GREEN address
	162	[ "${address}" = "${GREEN_ADDRESS}" ] && continue
	163
6874a576 PM	164	# Skip reverse resolution if user requested not to do so
	165	[ "${generateptr}" = "off" ] && continue
	166
f75c279b AF	167	# Add RDNS
	168	address=$(ip_address_revptr ${address})
	169	unbound-control -q local_data "${address} ${LOCAL_TTL} IN PTR ${fqdn}"
36792be6 MT	170	done < /var/ipfire/main/hosts
	171	}
	172
b8f5eda8 MT	173	write_forward_conf() {
	174	(
	175	config_header
	176
7ebc0a16	177	local insecure_zones="${INSECURE_ZONES}"
a6dcc5bb	178
1ececb67 MT	179	local enabled zone server servers remark disable_dnssec rest
1ececb67 MT	180	while IFS="," read -r enabled zone servers remark disable_dnssec rest; do
b8f5eda8 MT	181	# Line must be enabled.
	182	[ "${enabled}" = "on" ] \|\| continue
	183
a6dcc5bb MT	184	# Zones that end with .local are commonly used for internal
	185	# zones and therefore not signed
	186	case "${zone}" in
	187	*.local)
	188	insecure_zones="${insecure_zones} ${zone}"
	189	;;
1ececb67 MT	190	*)
	191	if [ "${disable_dnssec}" = "on" ]; then
	192	insecure_zones="${insecure_zones} ${zone}"
	193	fi
	194	;;
a6dcc5bb MT	195	esac
a6dcc5bb MT	196
c7e41255 MT	197	# Reverse-lookup zones must be stubs
	198	case "${zone}" in
	199	*.in-addr.arpa)
	200	echo "stub-zone:"
9f099932	201	echo " name: ${zone}"
c9ae511e	202	for server in ${servers//\|/ }; do
f33d2897 MT	203	if [[ ${server} =~ ^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
	204	echo " stub-addr: ${server}"
	205	else
	206	echo " stub-host: ${server}"
	207	fi
c9ae511e	208	done
c7e41255 MT	209	echo
c7e41255 MT	210	echo "server:"
9f099932	211	echo " local-zone: \"${zone}\" transparent"
c7e41255 MT	212	echo
	213	;;
	214	*)
	215	echo "forward-zone:"
9f099932	216	echo " name: ${zone}"
c9ae511e	217	for server in ${servers//\|/ }; do
f33d2897 MT	218	if [[ ${server} =~ ^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
	219	echo " forward-addr: ${server}"
	220	else
	221	echo " forward-host: ${server}"
	222	fi
c9ae511e	223	done
c7e41255 MT	224	echo
	225	;;
	226	esac
b8f5eda8	227	done < /var/ipfire/dnsforward/config
a6dcc5bb MT	228
	229	if [ -n "${insecure_zones}" ]; then
	230	echo "server:"
	231
	232	for zone in ${insecure_zones}; do
	233	echo " domain-insecure: ${zone}"
	234	done
	235	fi
b8f5eda8 MT	236	) > /etc/unbound/forward.conf
	237	}
	238
b658a451 MT	239	write_tuning_conf() {
	240	# https://www.unbound.net/documentation/howto_optimise.html
	241
	242	# Determine number of online processors
	243	local processors=$(getconf _NPROCESSORS_ONLN)
	244
	245	# Determine number of slabs
	246	local slabs=1
	247	while [ ${slabs} -lt ${processors} ]; do
	248	slabs=$(( ${slabs} * 2 ))
	249	done
	250
	251	# Determine amount of system memory
	252	local mem=$(get_memory_amount)
	253
	254	# In the worst case scenario, unbound can use double the
	255	# amount of memory allocated to a cache due to malloc overhead
	256
4a0d69ca MT	257	# Even larger systems with more than 8GB of RAM
	258	if [ ${mem} -ge 8192 ]; then
	259	mem=1024
	260
	261	# Extra large systems with more than 4GB of RAM
	262	elif [ ${mem} -ge 4096 ]; then
	263	mem=512
	264
b658a451	265	# Large systems with more than 2GB of RAM
4a0d69ca	266	elif [ ${mem} -ge 2048 ]; then
128db1a3	267	mem=256
b658a451	268
4a0d69ca MT	269	# Medium systems with more than 1GB of RAM
	270	elif [ ${mem} -ge 1024 ]; then
	271	mem=128
	272
b658a451 MT	273	# Small systems with less than 256MB of RAM
b658a451 MT	274	elif [ ${mem} -le 256 ]; then
128db1a3	275	mem=16
b658a451 MT	276
	277	# Everything else
	278	else
128db1a3	279	mem=64
b658a451 MT	280	fi
	281
	282	(
	283	config_header
	284
	285	# We run one thread per processor
	286	echo "num-threads: ${processors}"
5012e53c	287	echo "so-reuseport: yes"
b658a451 MT	288
	289	# Adjust number of slabs
	290	echo "infra-cache-slabs: ${slabs}"
	291	echo "key-cache-slabs: ${slabs}"
	292	echo "msg-cache-slabs: ${slabs}"
	293	echo "rrset-cache-slabs: ${slabs}"
	294
	295	# Slice up the cache
	296	echo "rrset-cache-size: $(( ${mem} / 2 ))m"
	297	echo "msg-cache-size: $(( ${mem} / 4 ))m"
	298	echo "key-cache-size: $(( ${mem} / 4 ))m"
0a7dca2c MT	299
	300	# Increase parallel queries
	301	echo "outgoing-range: 8192"
	302	echo "num-queries-per-thread: 4096"
c20b2009 MT	303
	304	# Use larger send/receive buffers
	305	echo "so-sndbuf: 4m"
	306	echo "so-rcvbuf: 4m"
b658a451 MT	307	) > /etc/unbound/tuning.conf
	308	}
	309
	310	get_memory_amount() {
	311	local key val unit
	312
	313	while read -r key val unit; do
	314	case "${key}" in
	315	MemTotal:*)
	316	# Convert to MB
	317	echo "$(( ${val} / 1024 ))"
	318	break
	319	;;
	320	esac
	321	done < /proc/meminfo
	322	}
b8f5eda8	323
b29c97b1 AF	324	test_name_server() {
b29c97b1 AF	325	local ns=${1}
8f3034d0	326	local args
b29c97b1 AF	327
	328	# Return codes:
	329	# 0 DNSSEC validating
	330	# 1 Error: unreachable, etc.
	331	# 2 DNSSEC aware
	332	# 3 NOT DNSSEC-aware
	333
	334	# Exit when the server is not reachable
	335	ns_is_online ${ns} \|\| return 1
	336
8f3034d0 MT	337	# Determine the maximum edns buffer size that works
	338	local edns_buffer_size=$(ns_determine_edns_buffer_size ${ns})
	339	if [ -n "${edns_buffer_size}" ]; then
	340	args="${args} +bufsize=${edns_buffer_size}"
	341	fi
	342
b29c97b1 AF	343	local errors
b29c97b1 AF	344	for rr in DNSKEY DS RRSIG; do
8f3034d0	345	if ! ns_forwards_${rr} ${ns} ${args}; then
b29c97b1 AF	346	errors="${errors} ${rr}"
	347	fi
	348	done
	349
	350	if [ -n "${errors}" ]; then
	351	echo >&2 "Unable to retrieve the following resource records from ${ns}: ${errors:1}"
	352	return 3
	353	fi
	354
8f3034d0	355	if ns_is_validating ${ns} ${args}; then
2aa15dee MT	356	# Return 0 if validating
	357	return 0
	358	else
	359	# Is DNSSEC-aware
	360	return 2
	361	fi
b29c97b1 AF	362	}
	363
	364	# Sends an A query to the nameserver w/o DNSSEC
	365	ns_is_online() {
	366	local ns=${1}
8f3034d0	367	shift
b29c97b1	368
8f3034d0	369	dig @${ns} +nodnssec A ${TEST_DOMAIN} $@ >/dev/null
b29c97b1 AF	370	}
	371
	372	# Resolving ${TEST_DOMAIN_FAIL} will fail if the nameserver is validating
	373	ns_is_validating() {
	374	local ns=${1}
8f3034d0	375	shift
b29c97b1	376
438da7e0 PM	377	if ! dig @${ns} A ${TEST_DOMAIN_FAIL} $@ \| grep -q SERVFAIL; then
	378	return 1
	379	else
	380	# Determine if NS replies with "ad" data flag if DNSSEC enabled
	381	dig @${ns} +dnssec SOA ${TEST_DOMAIN} $@ \| awk -F: '/\;\;\ flags\:/ { s=1; if (/\ ad/) s=0; exit s }'
	382	fi
b29c97b1 AF	383	}
	384
	385	# Checks if we can retrieve the DNSKEY for this domain.
	386	# dig will print the SOA if nothing was found
	387	ns_forwards_DNSKEY() {
	388	local ns=${1}
8f3034d0	389	shift
b29c97b1	390
8f3034d0	391	dig @${ns} DNSKEY ${TEST_DOMAIN} $@ \| grep -qv SOA
b29c97b1 AF	392	}
	393
	394	ns_forwards_DS() {
	395	local ns=${1}
8f3034d0	396	shift
b29c97b1	397
8f3034d0	398	dig @${ns} DS ${TEST_DOMAIN} $@ \| grep -qv SOA
b29c97b1 AF	399	}
	400
	401	ns_forwards_RRSIG() {
	402	local ns=${1}
8f3034d0	403	shift
b29c97b1	404
8f3034d0	405	dig @${ns} +dnssec A ${TEST_DOMAIN} $@ \| grep -q RRSIG
b29c97b1 AF	406	}
	407
	408	ns_supports_tcp() {
	409	local ns=${1}
8f3034d0 MT	410	shift
	411
	412	dig @${ns} +tcp A ${TEST_DOMAIN} $@ >/dev/null \|\| return 1
	413	}
	414
	415	ns_determine_edns_buffer_size() {
	416	local ns=${1}
	417	shift
	418
	419	local b
	420	for b in 4096 2048 1500 1480 1464 1400 1280 512; do
	421	if dig @${ns} +dnssec +bufsize=${b} A ${TEST_DOMAIN} $@ >/dev/null; then
	422	echo "${b}"
	423	return 0
	424	fi
	425	done
b29c97b1	426
8f3034d0	427	return 1
b29c97b1 AF	428	}
b29c97b1 AF	429
e432689a MT	430	get_root_nameservers() {
	431	while read -r hostname ttl record address; do
	432	# Searching for A records
	433	[ "${record}" = "A" ] \|\| continue
	434
	435	echo "${address}"
	436	done < /etc/unbound/root.hints
	437	}
	438
	439	can_resolve_root() {
	440	local ns
	441	for ns in $(get_root_nameservers); do
	442	if dig @${ns} +dnssec SOA . $@ >/dev/null; then
	443	return 0
	444	fi
	445	done
	446
	447	# none of the servers was reachable
	448	return 1
	449	}
	450
	451	enable_dnssec() {
	452	local status=$(unbound-control get_option val-permissive-mode)
	453
183b23b5 MT	454	# Log DNSSEC status
	455	echo "on" > /var/ipfire/red/dnssec-status
	456
094a27c8 MT	457	# Don't do anything if DNSSEC is already activated
	458	[ "${status}" = "no" ] && return 0
	459
e432689a MT	460	# Activate DNSSEC and flush cache with any stale and unvalidated data
	461	unbound-control -q set_option val-permissive-mode: no
	462	unbound-control -q flush_zone .
	463	}
	464
	465	disable_dnssec() {
183b23b5 MT	466	# Log DNSSEC status
	467	echo "off" > /var/ipfire/red/dnssec-status
	468
e432689a MT	469	unbound-control -q set_option val-permissive-mode: yes
	470	}
	471
68fac98a AF	472	fix_time_if_dns_fail() {
	473	# If DNS still not work try to init ntp with
	474	# hardcoded ntp.ipfire.org (81.3.27.46)
	475	if [ -e /var/ipfire/red/active ]; then
	476	host 0.ipfire.pool.ntp.org > /dev/null 2>&1
	477	if [ "${?}" != "0" ]; then
3eeff87f	478	boot_mesg "DNS still not functioning... Trying to sync time with ntp.ipfire.org (81.3.27.46)..."
68fac98a AF	479	loadproc /usr/local/bin/settime 81.3.27.46
	480	fi
	481	fi
	482	}
	483
d0e5f71f ML	484	case "$1" in
d0e5f71f ML	485	start)
80bc6022 MT	486	# Print a nicer messagen when unbound is already running
	487	if pidofproc -s unbound; then
	488	statusproc /usr/sbin/unbound
	489	exit 0
	490	fi
	491
b8f5eda8	492	eval $(/usr/local/bin/readhash /var/ipfire/ethernet/settings)
d0e5f71f	493
b8f5eda8	494	# Update configuration files
b658a451	495	write_tuning_conf
b8f5eda8 MT	496	write_forward_conf
	497
	498	boot_mesg "Starting Unbound DNS Proxy..."
	499	loadproc /usr/sbin/unbound \|\| exit $?
	500
f75c279b AF	501	# Make own hostname resolveable
	502	own_hostname
	503
b8f5eda8 MT	504	# Update any known forwarding name servers
b8f5eda8 MT	505	update_forwarders
36792be6 MT	506
	507	# Update hosts
	508	update_hosts
05478072	509
68fac98a	510	fix_time_if_dns_fail
b8f5eda8	511	;;
d0e5f71f ML	512
d0e5f71f ML	513	stop)
b8f5eda8 MT	514	boot_mesg "Stopping Unbound DNS Proxy..."
	515	killproc /usr/sbin/unbound
	516	;;
d0e5f71f ML	517
d0e5f71f ML	518	restart)
b8f5eda8 MT	519	$0 stop
	520	sleep 1
	521	$0 start
	522	;;
d0e5f71f ML	523
d0e5f71f ML	524	status)
b8f5eda8	525	statusproc /usr/sbin/unbound
b8f5eda8 MT	526	;;
	527
	528	update-forwarders)
cd812106 MT	529	# Do not try updating forwarders when unbound is not running
	530	if ! pgrep unbound &>/dev/null; then
	531	exit 0
	532	fi
	533
b8f5eda8	534	update_forwarders
68fac98a	535
391e3390 AF	536	unbound-control flush_negative > /dev/null
	537	unbound-control flush_bogus > /dev/null
	538
68fac98a	539	fix_time_if_dns_fail
b8f5eda8	540	;;
d0e5f71f	541
b29c97b1 AF	542	test-name-server)
	543	ns=${2}
	544
	545	test_name_server ${ns}
	546	ret=${?}
	547
	548	case "${ret}" in
	549	0)
	550	echo "${ns} is validating"
	551	;;
	552	2)
	553	echo "${ns} is DNSSEC-aware"
	554	;;
	555	3)
	556	echo "${ns} is NOT DNSSEC-aware"
	557	;;
	558	*)
	559	echo "Test failed for an unknown reason"
8f3034d0	560	exit ${ret}
b29c97b1 AF	561	;;
	562	esac
	563
	564	if ns_supports_tcp ${ns}; then
	565	echo "${ns} supports TCP fallback"
	566	else
	567	echo "${ns} does not support TCP fallback"
	568	fi
	569
8f3034d0 MT	570	edns_buffer_size=$(ns_determine_edns_buffer_size ${ns})
	571	if [ -n "${edns_buffer_size}" ]; then
	572	echo "EDNS buffer size for ${ns}: ${edns_buffer_size}"
	573	fi
	574
b29c97b1 AF	575	exit ${ret}
	576	;;
	577
d0e5f71f	578	*)
b29c97b1	579	echo "Usage: $0 {start\|stop\|restart\|status\|update-forwarders\|test-name-server}"
b8f5eda8 MT	580	exit 1
b8f5eda8 MT	581	;;
d0e5f71f ML	582	esac
	583
	584	# End $rc_base/init.d/unbound