2 # Begin $rc_base/init.d/unbound
4 # Description : Unbound DNS resolver boot script for IPfire
5 # Author : Marcel Lorenz <marcel.lorenz@ipfire.org>
10 TEST_DOMAIN
="ipfire.org"
12 # This domain will never validate
13 TEST_DOMAIN_FAIL
="dnssec-failed.org"
17 ENABLE_SAFE_SEARCH
=off
19 # Cache any local zones for 60 seconds
23 EDNS_DEFAULT_BUFFER_SIZE
=4096
25 # Load optional configuration
26 [ -e "/etc/sysconfig/unbound" ] && .
/etc
/sysconfig
/unbound
32 IFS
=.
read -r a1 a2 a3 a4
<<< ${addr}
34 echo "${a4}.${a3}.${a2}.${a1}.in-addr.arpa"
40 echo "$(</var/ipfire/red/dns${i})"
41 done 2>/dev
/null |
xargs echo
45 echo "# This file is automatically generated and any changes"
46 echo "# will be overwritten. DO NOT EDIT!"
51 if [ "${USE_FORWARDERS}" = "1" -a -e "/var/ipfire/red/active" ]; then
53 local broken_forwarders
56 for ns
in $
(read_name_servers
); do
57 test_name_server
${ns} &>/dev
/null
59 # Only use DNSSEC-validating or DNSSEC-aware name servers
61 forwarders
="${forwarders} ${ns}"
64 broken_forwarders
="${broken_forwarders} ${ns}"
69 # Determine EDNS buffer size
70 local new_edns_buffer_size
=${EDNS_DEFAULT_BUFFER_SIZE}
72 for ns
in ${forwarders}; do
73 local edns_buffer_size
=$
(ns_determine_edns_buffer_size
${ns})
74 if [ -n "${edns_buffer_size}" ]; then
75 if [ ${edns_buffer_size} -lt ${new_edns_buffer_size} ]; then
76 new_edns_buffer_size
=${edns_buffer_size}
81 if [ ${new_edns_buffer_size} -lt ${EDNS_DEFAULT_BUFFER_SIZE} ]; then
82 boot_mesg
"EDNS buffer size reduced to ${new_edns_buffer_size}" ${WARNING}
85 unbound-control
-q set_option edns-buffer-size
: ${new_edns_buffer_size}
88 # Show warning for any broken upstream name servers
89 if [ -n "${broken_forwarders}" ]; then
90 boot_mesg
"Ignoring broken upstream name server(s): ${broken_forwarders:1}" ${WARNING}
94 if [ -n "${forwarders}" ]; then
95 boot_mesg
"Configuring upstream name server(s): ${forwarders:1}" ${INFO}
98 # Make sure DNSSEC is activated
101 echo "${forwarders}" > /var
/ipfire
/red
/dns
102 unbound-control
-q forward
${forwarders}
105 # In case we have found no working forwarders
107 # Test if the recursor mode is available
108 if can_resolve_root
+bufsize
=${new_edns_buffer_size}; then
109 # Make sure DNSSEC is activated
112 boot_mesg
"Falling back to recursor mode" ${WARNING}
115 # If not, we set DNSSEC in permissive mode and allow using all recursors
116 elif [ -n "${broken_forwarders}" ]; then
119 boot_mesg
"DNSSEC has been set to permissive mode" ${FAILURE}
122 echo "${broken_forwarders}" > /var
/ipfire
/red
/dns
123 unbound-control
-q forward
${broken_forwarders}
129 # If forwarders cannot be used we run in recursor mode
130 echo "local recursor" > /var
/ipfire
/red
/dns
131 unbound-control
-q forward off
135 local hostname
=$
(hostname
-f)
136 # 1.1.1.1 is reserved for unused green, skip this
137 if [ -n "${GREEN_ADDRESS}" -a "${GREEN_ADDRESS}" != "1.1.1.1" ]; then
138 unbound-control
-q local_data
"${hostname} ${LOCAL_TTL} IN A ${GREEN_ADDRESS}"
142 for address
in ${GREEN_ADDRESS} ${BLUE_ADDRESS} ${ORANGE_ADDRESS}; do
143 [ -n "${address}" ] ||
continue
144 [ "${address}" = "1.1.1.1" ] && continue
146 address
=$
(ip_address_revptr
${address})
147 unbound-control
-q local_data
"${address} ${LOCAL_TTL} IN PTR ${hostname}"
152 local enabled address hostname domainname generateptr
154 while IFS
="," read -r enabled address hostname domainname generateptr
; do
155 [ "${enabled}" = "on" ] ||
continue
158 local fqdn
="${hostname}.${domainname}"
160 unbound-control
-q local_data
"${fqdn} ${LOCAL_TTL} IN A ${address}"
162 # Skip reverse resolution if the address equals the GREEN address
163 [ "${address}" = "${GREEN_ADDRESS}" ] && continue
165 # Skip reverse resolution if user requested not to do so
166 [ "${generateptr}" = "off" ] && continue
169 address
=$
(ip_address_revptr
${address})
170 unbound-control
-q local_data
"${address} ${LOCAL_TTL} IN PTR ${fqdn}"
171 done < /var
/ipfire
/main
/hosts
174 write_forward_conf
() {
178 local insecure_zones
="${INSECURE_ZONES}"
180 local enabled zone server servers remark disable_dnssec rest
181 while IFS
="," read -r enabled zone servers remark disable_dnssec rest
; do
182 # Line must be enabled.
183 [ "${enabled}" = "on" ] ||
continue
185 # Zones that end with .local are commonly used for internal
186 # zones and therefore not signed
189 insecure_zones
="${insecure_zones} ${zone}"
192 if [ "${disable_dnssec}" = "on" ]; then
193 insecure_zones
="${insecure_zones} ${zone}"
198 # Reverse-lookup zones must be stubs
202 echo " name: ${zone}"
203 for server
in ${servers//|/ }; do
204 if [[ ${server} =~ ^
[0-9]+\.
[0-9]+\.
[0-9]+\.
[0-9]+$
]]; then
205 echo " stub-addr: ${server}"
207 echo " stub-host: ${server}"
212 echo " local-zone: \"${zone}\" transparent"
217 echo " name: ${zone}"
218 for server
in ${servers//|/ }; do
219 if [[ ${server} =~ ^
[0-9]+\.
[0-9]+\.
[0-9]+\.
[0-9]+$
]]; then
220 echo " forward-addr: ${server}"
222 echo " forward-host: ${server}"
228 done < /var
/ipfire
/dnsforward
/config
230 if [ -n "${insecure_zones}" ]; then
233 for zone
in ${insecure_zones}; do
234 echo " domain-insecure: ${zone}"
237 ) > /etc
/unbound
/forward.conf
240 write_tuning_conf
() {
241 # https://www.unbound.net/documentation/howto_optimise.html
243 # Determine number of online processors
244 local processors
=$
(getconf _NPROCESSORS_ONLN
)
246 # Determine number of slabs
248 while [ ${slabs} -lt ${processors} ]; do
249 slabs
=$
(( ${slabs} * 2 ))
252 # Determine amount of system memory
253 local mem
=$
(get_memory_amount
)
255 # In the worst case scenario, unbound can use double the
256 # amount of memory allocated to a cache due to malloc overhead
258 # Even larger systems with more than 8GB of RAM
259 if [ ${mem} -ge 8192 ]; then
262 # Extra large systems with more than 4GB of RAM
263 elif [ ${mem} -ge 4096 ]; then
266 # Large systems with more than 2GB of RAM
267 elif [ ${mem} -ge 2048 ]; then
270 # Medium systems with more than 1GB of RAM
271 elif [ ${mem} -ge 1024 ]; then
274 # Small systems with less than 256MB of RAM
275 elif [ ${mem} -le 256 ]; then
286 # We run one thread per processor
287 echo "num-threads: ${processors}"
288 echo "so-reuseport: yes"
290 # Adjust number of slabs
291 echo "infra-cache-slabs: ${slabs}"
292 echo "key-cache-slabs: ${slabs}"
293 echo "msg-cache-slabs: ${slabs}"
294 echo "rrset-cache-slabs: ${slabs}"
297 echo "rrset-cache-size: $(( ${mem} / 2 ))m"
298 echo "msg-cache-size: $(( ${mem} / 4 ))m"
299 echo "key-cache-size: $(( ${mem} / 4 ))m"
301 # Increase parallel queries
302 echo "outgoing-range: 8192"
303 echo "num-queries-per-thread: 4096"
305 # Use larger send/receive buffers
308 ) > /etc
/unbound
/tuning.conf
311 get_memory_amount
() {
314 while read -r key val unit
; do
318 echo "$(( ${val} / 1024 ))"
330 # 0 DNSSEC validating
331 # 1 Error: unreachable, etc.
335 # Exit when the server is not reachable
336 ns_is_online
${ns} ||
return 1
338 # Determine the maximum edns buffer size that works
339 local edns_buffer_size
=$
(ns_determine_edns_buffer_size
${ns})
340 if [ -n "${edns_buffer_size}" ]; then
341 args
="${args} +bufsize=${edns_buffer_size}"
345 for rr
in DNSKEY DS RRSIG
; do
346 if ! ns_forwards_
${rr} ${ns} ${args}; then
347 errors
="${errors} ${rr}"
351 if [ -n "${errors}" ]; then
352 echo >&2 "Unable to retrieve the following resource records from ${ns}: ${errors:1}"
356 if ns_is_validating
${ns} ${args}; then
357 # Return 0 if validating
365 # Sends an A query to the nameserver w/o DNSSEC
370 dig @
${ns} +nodnssec A
${TEST_DOMAIN} $@
>/dev
/null
373 # Resolving ${TEST_DOMAIN_FAIL} will fail if the nameserver is validating
378 if ! dig @
${ns} A
${TEST_DOMAIN_FAIL} $@ |
grep -q SERVFAIL
; then
381 # Determine if NS replies with "ad" data flag if DNSSEC enabled
382 dig @
${ns} +dnssec SOA ${TEST_DOMAIN} $@ | awk -F: '/\;\;\ flags\:/ { s=1; if (/\ ad/) s=0; exit s }'
386 # Checks if we can retrieve the DNSKEY for this domain.
387 # dig will print the SOA if nothing was found
388 ns_forwards_DNSKEY() {
392 dig @${ns} DNSKEY ${TEST_DOMAIN} $@ | grep -qv SOA
399 dig @${ns} DS ${TEST_DOMAIN} $@ | grep -qv SOA
402 ns_forwards_RRSIG() {
406 dig @${ns} +dnssec A ${TEST_DOMAIN} $@ | grep -q RRSIG
413 dig @${ns} +tcp A ${TEST_DOMAIN} $@ >/dev/null || return 1
416 ns_determine_edns_buffer_size() {
421 for b in 4096 2048 1500 1480 1464 1400 1280 512; do
422 if dig @${ns} +dnssec +bufsize=${b} A ${TEST_DOMAIN} $@ >/dev/null; then
431 get_root_nameservers() {
432 while read -r hostname ttl record address; do
433 # Searching for A records
434 [ "${record}" = "A" ] || continue
437 done < /etc/unbound/root.hints
442 for ns in $(get_root_nameservers); do
443 if dig @${ns} +dnssec SOA . $@ >/dev/null; then
448 # none of the servers was reachable
453 local status=$(unbound-control get_option val-permissive-mode)
456 echo "on" > /var/ipfire/red/dnssec-status
458 # Don't
do anything
if DNSSEC is already activated
459 [ "${status}" = "no" ] && return 0
461 # Activate DNSSEC and flush cache with any stale and unvalidated data
462 unbound-control
-q set_option val-permissive-mode
: no
463 unbound-control
-q flush_zone .
468 echo "off" > /var
/ipfire
/red
/dnssec-status
470 unbound-control
-q set_option val-permissive-mode
: yes
473 fix_time_if_dns_fail
() {
474 # If DNS still not work try to init ntp with
475 # hardcoded ntp.ipfire.org (81.3.27.46)
476 if [ -e /var
/ipfire
/red
/active
]; then
477 host 0.ipfire.pool.ntp.org
> /dev
/null
2>&1
478 if [ "${?}" != "0" ]; then
479 boot_mesg
"DNS still not functioning... Trying to sync time with ntp.ipfire.org (81.3.27.46)..."
480 loadproc
/usr
/local
/bin
/settime
81.3.27.46
485 # Sets up Safe Search for various search engines
486 write_safe_search_conf
() {
684 # Nothing to do if safe search is not enabled
685 if [ "${ENABLE_SAFE_SEARCH}" != "on" ]; then
689 # This all belongs into the server: section
693 echo " local-zone: bing.com transparent"
694 echo " local-data: \"www.bing.com CNAME strict.bing.com.\""
697 echo " local-zone: duckduckgo.com transparent"
698 echo " local-data: \"duckduckgo.com CNAME safe.duckduckgo.com.\""
702 for domain
in ${google_tlds[@]}; do
703 echo " local-zone: ${domain} transparent"
704 echo " local-data: \"www.${domain} CNAME forcesafesearch.google.com.\""
708 echo " local-zone: yandex.ru transparent"
709 echo " local-data: \"yandex.ru A 213.180.193.56\""
710 ) > /etc
/unbound
/safe-search.conf
715 # Print a nicer messagen when unbound is already running
716 if pidofproc
-s unbound
; then
717 statusproc
/usr
/sbin
/unbound
721 eval $
(/usr
/local
/bin
/readhash
/var
/ipfire
/ethernet
/settings
)
723 # Update configuration files
726 write_safe_search_conf
728 boot_mesg
"Starting Unbound DNS Proxy..."
729 loadproc
/usr
/sbin
/unbound ||
exit $?
731 # Make own hostname resolveable
734 # Update any known forwarding name servers
744 boot_mesg
"Stopping Unbound DNS Proxy..."
745 killproc
/usr
/sbin
/unbound
755 statusproc
/usr
/sbin
/unbound
759 # Do not try updating forwarders when unbound is not running
760 if ! pgrep unbound
&>/dev
/null
; then
766 unbound-control flush_negative
> /dev
/null
767 unbound-control flush_bogus
> /dev
/null
775 test_name_server
${ns}
780 echo "${ns} is validating"
783 echo "${ns} is DNSSEC-aware"
786 echo "${ns} is NOT DNSSEC-aware"
789 echo "Test failed for an unknown reason"
794 if ns_supports_tcp
${ns}; then
795 echo "${ns} supports TCP fallback"
797 echo "${ns} does not support TCP fallback"
800 edns_buffer_size
=$
(ns_determine_edns_buffer_size
${ns})
801 if [ -n "${edns_buffer_size}" ]; then
802 echo "EDNS buffer size for ${ns}: ${edns_buffer_size}"
809 echo "Usage: $0 {start|stop|restart|status|update-forwarders|test-name-server}"
814 # End $rc_base/init.d/unbound