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
44 check_red_has_carrier_and_ip
() {
45 # Interface configured ?
46 [ ! -e "/var/ipfire/red/iface" ] && return 0;
49 [ ! -e "/sys/class/net/$(</var/ipfire/red/iface)" ] && return 0;
52 [ ! "$(</sys/class/net/$(</var/ipfire/red/iface)/carrier)" = "1" ] && return 0;
55 [ "$(ip address show dev $(</var/ipfire/red/iface) | grep "inet
")" = "" ] && return 0;
61 echo "# This file is automatically generated and any changes"
62 echo "# will be overwritten. DO NOT EDIT!"
67 check_red_has_carrier_and_ip
68 if [ "${USE_FORWARDERS}" = "1" -a "${?}" = "1" ]; then
70 local broken_forwarders
73 for ns
in $
(read_name_servers
); do
74 test_name_server
${ns} &>/dev
/null
76 # Only use DNSSEC-validating or DNSSEC-aware name servers
78 forwarders
="${forwarders} ${ns}"
81 broken_forwarders
="${broken_forwarders} ${ns}"
86 # Determine EDNS buffer size
87 local new_edns_buffer_size
=${EDNS_DEFAULT_BUFFER_SIZE}
89 for ns
in ${forwarders}; do
90 local edns_buffer_size
=$
(ns_determine_edns_buffer_size
${ns})
91 if [ -n "${edns_buffer_size}" ]; then
92 if [ ${edns_buffer_size} -lt ${new_edns_buffer_size} ]; then
93 new_edns_buffer_size
=${edns_buffer_size}
98 if [ ${new_edns_buffer_size} -lt ${EDNS_DEFAULT_BUFFER_SIZE} ]; then
99 boot_mesg
"EDNS buffer size reduced to ${new_edns_buffer_size}" ${WARNING}
102 unbound-control
-q set_option edns-buffer-size
: ${new_edns_buffer_size}
105 # Show warning for any broken upstream name servers
106 if [ -n "${broken_forwarders}" ]; then
107 boot_mesg
"Ignoring broken upstream name server(s): ${broken_forwarders:1}" ${WARNING}
111 if [ -n "${forwarders}" ]; then
112 boot_mesg
"Configuring upstream name server(s): ${forwarders:1}" ${INFO}
115 # Make sure DNSSEC is activated
118 echo "${forwarders}" > /var
/ipfire
/red
/dns
119 unbound-control
-q forward
${forwarders}
122 # In case we have found no working forwarders
124 # Test if the recursor mode is available
125 if can_resolve_root
+bufsize
=${new_edns_buffer_size}; then
126 # Make sure DNSSEC is activated
129 boot_mesg
"Falling back to recursor mode" ${WARNING}
132 # If not, we set DNSSEC in permissive mode and allow using all recursors
133 elif [ -n "${broken_forwarders}" ]; then
136 boot_mesg
"DNSSEC has been set to permissive mode" ${FAILURE}
139 echo "${broken_forwarders}" > /var
/ipfire
/red
/dns
140 unbound-control
-q forward
${broken_forwarders}
146 # If forwarders cannot be used we run in recursor mode
147 echo "local recursor" > /var
/ipfire
/red
/dns
148 unbound-control
-q forward off
151 remove_forwarders
() {
153 echo "local recursor" > /var
/ipfire
/red
/dns
154 unbound-control
-q forward off
159 local hostname
=$
(hostname
-f)
160 # 1.1.1.1 is reserved for unused green, skip this
161 if [ -n "${GREEN_ADDRESS}" -a "${GREEN_ADDRESS}" != "1.1.1.1" ]; then
162 unbound-control
-q local_data
"${hostname} ${LOCAL_TTL} IN A ${GREEN_ADDRESS}"
166 for address
in ${GREEN_ADDRESS} ${BLUE_ADDRESS} ${ORANGE_ADDRESS}; do
167 [ -n "${address}" ] ||
continue
168 [ "${address}" = "1.1.1.1" ] && continue
170 address
=$
(ip_address_revptr
${address})
171 unbound-control
-q local_data
"${address} ${LOCAL_TTL} IN PTR ${hostname}"
176 local enabled address hostname domainname generateptr
178 while IFS
="," read -r enabled address hostname domainname generateptr
; do
179 [ "${enabled}" = "on" ] ||
continue
182 local fqdn
="${hostname}.${domainname}"
184 unbound-control
-q local_data
"${fqdn} ${LOCAL_TTL} IN A ${address}"
186 # Skip reverse resolution if the address equals the GREEN address
187 [ "${address}" = "${GREEN_ADDRESS}" ] && continue
189 # Skip reverse resolution if user requested not to do so
190 [ "${generateptr}" = "off" ] && continue
193 address
=$
(ip_address_revptr
${address})
194 unbound-control
-q local_data
"${address} ${LOCAL_TTL} IN PTR ${fqdn}"
195 done < /var
/ipfire
/main
/hosts
198 write_forward_conf
() {
202 local insecure_zones
="${INSECURE_ZONES}"
204 local enabled zone server servers remark disable_dnssec rest
205 while IFS
="," read -r enabled zone servers remark disable_dnssec rest
; do
206 # Line must be enabled.
207 [ "${enabled}" = "on" ] ||
continue
209 # Zones that end with .local are commonly used for internal
210 # zones and therefore not signed
213 insecure_zones
="${insecure_zones} ${zone}"
216 if [ "${disable_dnssec}" = "on" ]; then
217 insecure_zones
="${insecure_zones} ${zone}"
222 # Reverse-lookup zones must be stubs
226 echo " name: ${zone}"
227 for server
in ${servers//|/ }; do
228 if [[ ${server} =~ ^
[0-9]+\.
[0-9]+\.
[0-9]+\.
[0-9]+$
]]; then
229 echo " stub-addr: ${server}"
231 echo " stub-host: ${server}"
236 echo " local-zone: \"${zone}\" transparent"
241 echo " name: ${zone}"
242 for server
in ${servers//|/ }; do
243 if [[ ${server} =~ ^
[0-9]+\.
[0-9]+\.
[0-9]+\.
[0-9]+$
]]; then
244 echo " forward-addr: ${server}"
246 echo " forward-host: ${server}"
252 done < /var
/ipfire
/dnsforward
/config
254 if [ -n "${insecure_zones}" ]; then
257 for zone
in ${insecure_zones}; do
258 echo " domain-insecure: ${zone}"
261 ) > /etc
/unbound
/forward.conf
264 write_tuning_conf
() {
265 # https://www.unbound.net/documentation/howto_optimise.html
267 # Determine number of online processors
268 local processors
=$
(getconf _NPROCESSORS_ONLN
)
270 # Determine number of slabs
272 while [ ${slabs} -lt ${processors} ]; do
273 slabs
=$
(( ${slabs} * 2 ))
276 # Determine amount of system memory
277 local mem
=$
(get_memory_amount
)
279 # In the worst case scenario, unbound can use double the
280 # amount of memory allocated to a cache due to malloc overhead
282 # Even larger systems with more than 8GB of RAM
283 if [ ${mem} -ge 8192 ]; then
286 # Extra large systems with more than 4GB of RAM
287 elif [ ${mem} -ge 4096 ]; then
290 # Large systems with more than 2GB of RAM
291 elif [ ${mem} -ge 2048 ]; then
294 # Medium systems with more than 1GB of RAM
295 elif [ ${mem} -ge 1024 ]; then
298 # Small systems with less than 256MB of RAM
299 elif [ ${mem} -le 256 ]; then
310 # We run one thread per processor
311 echo "num-threads: ${processors}"
312 echo "so-reuseport: yes"
314 # Adjust number of slabs
315 echo "infra-cache-slabs: ${slabs}"
316 echo "key-cache-slabs: ${slabs}"
317 echo "msg-cache-slabs: ${slabs}"
318 echo "rrset-cache-slabs: ${slabs}"
321 echo "rrset-cache-size: $(( ${mem} / 2 ))m"
322 echo "msg-cache-size: $(( ${mem} / 4 ))m"
323 echo "key-cache-size: $(( ${mem} / 4 ))m"
325 # Increase parallel queries
326 echo "outgoing-range: 8192"
327 echo "num-queries-per-thread: 4096"
329 # Use larger send/receive buffers
332 ) > /etc
/unbound
/tuning.conf
335 get_memory_amount
() {
338 while read -r key val unit
; do
342 echo "$(( ${val} / 1024 ))"
354 # 0 DNSSEC validating
355 # 1 Error: unreachable, etc.
359 # Exit when the server is not reachable
360 ns_is_online
${ns} ||
return 1
362 # Determine the maximum edns buffer size that works
363 local edns_buffer_size
=$
(ns_determine_edns_buffer_size
${ns})
364 if [ -n "${edns_buffer_size}" ]; then
365 args
="${args} +bufsize=${edns_buffer_size}"
369 for rr
in DNSKEY DS RRSIG
; do
370 if ! ns_forwards_
${rr} ${ns} ${args}; then
371 errors
="${errors} ${rr}"
375 if [ -n "${errors}" ]; then
376 echo >&2 "Unable to retrieve the following resource records from ${ns}: ${errors:1}"
380 if ns_is_validating
${ns} ${args}; then
381 # Return 0 if validating
389 # Sends an A query to the nameserver w/o DNSSEC
394 dig @
${ns} +nodnssec A
${TEST_DOMAIN} $@
>/dev
/null
397 # Resolving ${TEST_DOMAIN_FAIL} will fail if the nameserver is validating
402 if ! dig @
${ns} A
${TEST_DOMAIN_FAIL} $@ |
grep -q SERVFAIL
; then
405 # Determine if NS replies with "ad" data flag if DNSSEC enabled
406 dig @
${ns} +dnssec SOA ${TEST_DOMAIN} $@ | awk -F: '/\;\;\ flags\:/ { s=1; if (/\ ad/) s=0; exit s }'
410 # Checks if we can retrieve the DNSKEY for this domain.
411 # dig will print the SOA if nothing was found
412 ns_forwards_DNSKEY() {
416 dig @${ns} DNSKEY ${TEST_DOMAIN} $@ | grep -qv SOA
423 dig @${ns} DS ${TEST_DOMAIN} $@ | grep -qv SOA
426 ns_forwards_RRSIG() {
430 dig @${ns} +dnssec A ${TEST_DOMAIN} $@ | grep -q RRSIG
437 dig @${ns} +tcp A ${TEST_DOMAIN} $@ >/dev/null || return 1
440 ns_determine_edns_buffer_size() {
445 for b in 4096 2048 1500 1480 1464 1400 1280 512; do
446 if dig @${ns} +dnssec +bufsize=${b} A ${TEST_DOMAIN} $@ >/dev/null; then
455 get_root_nameservers() {
456 while read -r hostname ttl record address; do
457 # Searching for A records
458 [ "${record}" = "A" ] || continue
461 done < /etc/unbound/root.hints
466 for ns in $(get_root_nameservers); do
467 if dig @${ns} +dnssec SOA . $@ >/dev/null; then
472 # none of the servers was reachable
477 local status=$(unbound-control get_option val-permissive-mode)
480 echo "on" > /var/ipfire/red/dnssec-status
482 # Don't
do anything
if DNSSEC is already activated
483 [ "${status}" = "no" ] && return 0
485 # Activate DNSSEC and flush cache with any stale and unvalidated data
486 unbound-control
-q set_option val-permissive-mode
: no
487 unbound-control
-q flush_zone .
492 echo "off" > /var
/ipfire
/red
/dnssec-status
494 unbound-control
-q set_option val-permissive-mode
: yes
497 fix_time_if_dns_fail
() {
498 # If DNS still not work try to init ntp with
499 # hardcoded ntp.ipfire.org (81.3.27.46)
500 check_red_has_carrier_and_ip
501 if [ -e "/var/ipfire/red/iface" -a "${?}" = "1" ]; then
502 host 0.ipfire.pool.ntp.org
> /dev
/null
2>&1
503 if [ "${?}" != "0" ]; then
504 boot_mesg
"DNS still not functioning... Trying to sync time with ntp.ipfire.org (81.3.27.46)..."
505 loadproc
/usr
/local
/bin
/settime
81.3.27.46
511 local hostname
="${1}"
515 for ns
in $
(read_name_servers
); do
517 for answer
in $
(dig +short
"@${ns}" A
"${hostname}"); do
520 # Filter out non-IP addresses
521 if [[ ! "${answer}" =~ \.$
]]; then
526 # End loop when we have got something
527 [ ${found} -eq 1 ] && break
531 # Sets up Safe Search for various search engines
532 write_safe_search_conf
() {
730 # Nothing to do if safe search is not enabled
731 if [ "${ENABLE_SAFE_SEARCH}" != "on" ]; then
735 # This all belongs into the server: section
739 echo " local-zone: bing.com transparent"
740 for address
in $
(resolve
"strict.bing.com"); do
741 echo " local-data: \"www.bing.com ${LOCAL_TTL} IN A ${address}\""
745 echo " local-zone: duckduckgo.com typetransparent"
746 for address
in $
(resolve
"safe.duckduckgo.com"); do
747 echo " local-data: \"duckduckgo.com ${LOCAL_TTL} IN A ${address}\""
751 addresses
="$(resolve "forcesafesearch.google.com
")"
753 for domain
in ${google_tlds[@]}; do
754 echo " local-zone: ${domain} transparent"
755 for address
in ${addresses}; do
756 echo " local-data: \"www.${domain} ${LOCAL_TTL} IN A ${address}\""
761 for domain
in yandex.com yandex.ru
; do
762 echo " local-zone: ${domain} typetransparent"
763 for address
in $
(resolve
"familysearch.${domain}"); do
764 echo " local-data: \"${domain} ${LOCAL_TTL} IN A ${address}\""
769 echo " local-zone: youtube.com transparent"
770 for address
in $
(resolve
"restrictmoderate.youtube.com"); do
771 echo " local-data: \"www.youtube.com ${LOCAL_TTL} IN A ${address}\""
773 ) > /etc
/unbound
/safe-search.conf
778 # Print a nicer messagen when unbound is already running
779 if pidofproc
-s unbound
; then
780 statusproc
/usr
/sbin
/unbound
784 eval $
(/usr
/local
/bin
/readhash
/var
/ipfire
/ethernet
/settings
)
786 # Update configuration files
789 write_safe_search_conf
791 boot_mesg
"Starting Unbound DNS Proxy..."
792 loadproc
/usr
/sbin
/unbound ||
exit $?
794 # Make own hostname resolveable
797 # Update any known forwarding name servers
807 boot_mesg
"Stopping Unbound DNS Proxy..."
808 killproc
/usr
/sbin
/unbound
818 statusproc
/usr
/sbin
/unbound
822 # Do not try updating forwarders when unbound is not running
823 if ! pgrep unbound
&>/dev
/null
; then
829 unbound-control flush_negative
> /dev
/null
830 unbound-control flush_bogus
> /dev
/null
836 # Do not try updating forwarders when unbound is not running
837 if ! pgrep unbound
&>/dev
/null
; then
843 unbound-control flush_negative
> /dev
/null
844 unbound-control flush_bogus
> /dev
/null
851 test_name_server
${ns}
856 echo "${ns} is validating"
859 echo "${ns} is DNSSEC-aware"
862 echo "${ns} is NOT DNSSEC-aware"
865 echo "Test failed for an unknown reason"
870 if ns_supports_tcp
${ns}; then
871 echo "${ns} supports TCP fallback"
873 echo "${ns} does not support TCP fallback"
876 edns_buffer_size
=$
(ns_determine_edns_buffer_size
${ns})
877 if [ -n "${edns_buffer_size}" ]; then
878 echo "EDNS buffer size for ${ns}: ${edns_buffer_size}"
889 echo "Usage: $0 {start|stop|restart|status|update-forwarders|remove-forwarders|test-name-server|resolve}"
894 # End $rc_base/init.d/unbound