[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

function cidr() {
    local cidr nbits IFS;
    IFS=. read -r i1 i2 i3 i4 <<< ${1}
    IFS=. read -r m1 m2 m3 m4 <<< ${2}
    cidr=$(printf "%d.%d.%d.%d\n" "$((i1 & m1))" "$((i2 & m2))" "$((i3 & m3))" "$((i4 & m4))")
    nbits=0
    IFS=.
    for dec in $2 ; do
        case $dec in
            255) let nbits+=8;;
            254) let nbits+=7;;
            252) let nbits+=6;;
            248) let nbits+=5;;
            240) let nbits+=4;;
            224) let nbits+=3;;
            192) let nbits+=2;;
            128) let nbits+=1;;
            0);;
            *) echo "Error: $dec is not recognised"; exit 1
        esac
    done
    echo "${cidr}/${nbits}"
}

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

	while IFS="," read -r enabled address hostname domainname; 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

		# 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 remark
		while IFS="," read -r enabled zone server remark; 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}"
					;;
			esac

			# Reverse-lookup zones must be stubs
			case "${zone}" in
				*.in-addr.arpa)
					echo "stub-zone:"
					echo "	name: ${zone}."
					echo "	stub-addr: ${server}"
					echo
					echo "server:"
					echo "	local-zone: \"${zone}.\" transparent"
					echo
					;;
				*)
					echo "forward-zone:"
					echo "	name: ${zone}."
					echo "	forward-addr: ${server}"
					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 work ... init time with ntp.ipfire.org at 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)

		# Create control keys at first run
		if [ ! -r "/etc/unbound/unbound_control.key" ]; then
			unbound-control-setup -d /etc/unbound &>/dev/null
		fi

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