]> git.ipfire.org Git - ipfire-2.x.git/blame - src/initscripts/system/unbound
unbound: Increase size of send/receive buffers
[ipfire-2.x.git] / src / initscripts / system / unbound
CommitLineData
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
10TEST_DOMAIN="ipfire.org"
11
12# This domain will never validate
13TEST_DOMAIN_FAIL="dnssec-failed.org"
14
7ebc0a16 15INSECURE_ZONES=
b8f5eda8 16USE_FORWARDERS=1
d0e5f71f 17
36792be6
MT
18# Cache any local zones for 60 seconds
19LOCAL_TTL=60
20
b2f96a94
MT
21# EDNS buffer size
22EDNS_DEFAULT_BUFFER_SIZE=4096
23
b8f5eda8
MT
24# Load optional configuration
25[ -e "/etc/sysconfig/unbound" ] && . /etc/sysconfig/unbound
d0e5f71f
ML
26
27function 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
51ip_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
60read_name_servers() {
61 local i
62 for i in 1 2; do
63 echo "$(</var/ipfire/red/dns${i})"
64 done | xargs echo
65}
66
67config_header() {
68 echo "# This file is automatically generated and any changes"
69 echo "# will be overwritten. DO NOT EDIT!"
70 echo
71}
72
73update_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}
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}
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
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}
156
f75c279b
AF
157own_hostname() {
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
174update_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
194write_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
b8f5eda8
MT
213 echo "forward-zone:"
214 echo " name: ${zone}"
215 echo " forward-addr: ${server}"
216 echo
217 done < /var/ipfire/dnsforward/config
a6dcc5bb
MT
218
219 if [ -n "${insecure_zones}" ]; then
220 echo "server:"
221
222 for zone in ${insecure_zones}; do
223 echo " domain-insecure: ${zone}"
224 done
225 fi
b8f5eda8
MT
226 ) > /etc/unbound/forward.conf
227}
228
b658a451
MT
229write_tuning_conf() {
230 # https://www.unbound.net/documentation/howto_optimise.html
231
232 # Determine number of online processors
233 local processors=$(getconf _NPROCESSORS_ONLN)
234
235 # Determine number of slabs
236 local slabs=1
237 while [ ${slabs} -lt ${processors} ]; do
238 slabs=$(( ${slabs} * 2 ))
239 done
240
241 # Determine amount of system memory
242 local mem=$(get_memory_amount)
243
244 # In the worst case scenario, unbound can use double the
245 # amount of memory allocated to a cache due to malloc overhead
246
247 # Large systems with more than 2GB of RAM
248 if [ ${mem} -ge 2048 ]; then
249 mem=128
250
251 # Small systems with less than 256MB of RAM
252 elif [ ${mem} -le 256 ]; then
253 mem=8
254
255 # Everything else
256 else
257 mem=32
258 fi
259
260 (
261 config_header
262
263 # We run one thread per processor
264 echo "num-threads: ${processors}"
5012e53c 265 echo "so-reuseport: yes"
b658a451
MT
266
267 # Adjust number of slabs
268 echo "infra-cache-slabs: ${slabs}"
269 echo "key-cache-slabs: ${slabs}"
270 echo "msg-cache-slabs: ${slabs}"
271 echo "rrset-cache-slabs: ${slabs}"
272
273 # Slice up the cache
274 echo "rrset-cache-size: $(( ${mem} / 2 ))m"
275 echo "msg-cache-size: $(( ${mem} / 4 ))m"
276 echo "key-cache-size: $(( ${mem} / 4 ))m"
0a7dca2c
MT
277
278 # Increase parallel queries
279 echo "outgoing-range: 8192"
280 echo "num-queries-per-thread: 4096"
c20b2009
MT
281
282 # Use larger send/receive buffers
283 echo "so-sndbuf: 4m"
284 echo "so-rcvbuf: 4m"
b658a451
MT
285 ) > /etc/unbound/tuning.conf
286}
287
288get_memory_amount() {
289 local key val unit
290
291 while read -r key val unit; do
292 case "${key}" in
293 MemTotal:*)
294 # Convert to MB
295 echo "$(( ${val} / 1024 ))"
296 break
297 ;;
298 esac
299 done < /proc/meminfo
300}
b8f5eda8 301
b29c97b1
AF
302test_name_server() {
303 local ns=${1}
8f3034d0 304 local args
b29c97b1
AF
305
306 # Return codes:
307 # 0 DNSSEC validating
308 # 1 Error: unreachable, etc.
309 # 2 DNSSEC aware
310 # 3 NOT DNSSEC-aware
311
312 # Exit when the server is not reachable
313 ns_is_online ${ns} || return 1
314
8f3034d0
MT
315 # Determine the maximum edns buffer size that works
316 local edns_buffer_size=$(ns_determine_edns_buffer_size ${ns})
317 if [ -n "${edns_buffer_size}" ]; then
318 args="${args} +bufsize=${edns_buffer_size}"
319 fi
320
b29c97b1
AF
321 local errors
322 for rr in DNSKEY DS RRSIG; do
8f3034d0 323 if ! ns_forwards_${rr} ${ns} ${args}; then
b29c97b1
AF
324 errors="${errors} ${rr}"
325 fi
326 done
327
328 if [ -n "${errors}" ]; then
329 echo >&2 "Unable to retrieve the following resource records from ${ns}: ${errors:1}"
330 return 3
331 fi
332
8f3034d0 333 if ns_is_validating ${ns} ${args}; then
2aa15dee
MT
334 # Return 0 if validating
335 return 0
336 else
337 # Is DNSSEC-aware
338 return 2
339 fi
b29c97b1
AF
340}
341
342# Sends an A query to the nameserver w/o DNSSEC
343ns_is_online() {
344 local ns=${1}
8f3034d0 345 shift
b29c97b1 346
8f3034d0 347 dig @${ns} +nodnssec A ${TEST_DOMAIN} $@ >/dev/null
b29c97b1
AF
348}
349
350# Resolving ${TEST_DOMAIN_FAIL} will fail if the nameserver is validating
351ns_is_validating() {
352 local ns=${1}
8f3034d0 353 shift
b29c97b1 354
8f3034d0 355 dig @${ns} A ${TEST_DOMAIN_FAIL} $@ | grep -q SERVFAIL
b29c97b1
AF
356}
357
358# Checks if we can retrieve the DNSKEY for this domain.
359# dig will print the SOA if nothing was found
360ns_forwards_DNSKEY() {
361 local ns=${1}
8f3034d0 362 shift
b29c97b1 363
8f3034d0 364 dig @${ns} DNSKEY ${TEST_DOMAIN} $@ | grep -qv SOA
b29c97b1
AF
365}
366
367ns_forwards_DS() {
368 local ns=${1}
8f3034d0 369 shift
b29c97b1 370
8f3034d0 371 dig @${ns} DS ${TEST_DOMAIN} $@ | grep -qv SOA
b29c97b1
AF
372}
373
374ns_forwards_RRSIG() {
375 local ns=${1}
8f3034d0 376 shift
b29c97b1 377
8f3034d0 378 dig @${ns} +dnssec A ${TEST_DOMAIN} $@ | grep -q RRSIG
b29c97b1
AF
379}
380
381ns_supports_tcp() {
382 local ns=${1}
8f3034d0
MT
383 shift
384
385 dig @${ns} +tcp A ${TEST_DOMAIN} $@ >/dev/null || return 1
386}
387
388ns_determine_edns_buffer_size() {
389 local ns=${1}
390 shift
391
392 local b
393 for b in 4096 2048 1500 1480 1464 1400 1280 512; do
394 if dig @${ns} +dnssec +bufsize=${b} A ${TEST_DOMAIN} $@ >/dev/null; then
395 echo "${b}"
396 return 0
397 fi
398 done
b29c97b1 399
8f3034d0 400 return 1
b29c97b1
AF
401}
402
e432689a
MT
403get_root_nameservers() {
404 while read -r hostname ttl record address; do
405 # Searching for A records
406 [ "${record}" = "A" ] || continue
407
408 echo "${address}"
409 done < /etc/unbound/root.hints
410}
411
412can_resolve_root() {
413 local ns
414 for ns in $(get_root_nameservers); do
415 if dig @${ns} +dnssec SOA . $@ >/dev/null; then
416 return 0
417 fi
418 done
419
420 # none of the servers was reachable
421 return 1
422}
423
424enable_dnssec() {
425 local status=$(unbound-control get_option val-permissive-mode)
426
427 # Don't do anything if DNSSEC is already activated
428 [ "${status}" = "no" ] && return 0
429
430 # Activate DNSSEC and flush cache with any stale and unvalidated data
431 unbound-control -q set_option val-permissive-mode: no
432 unbound-control -q flush_zone .
433}
434
435disable_dnssec() {
436 unbound-control -q set_option val-permissive-mode: yes
437}
438
d0e5f71f
ML
439case "$1" in
440 start)
80bc6022
MT
441 # Print a nicer messagen when unbound is already running
442 if pidofproc -s unbound; then
443 statusproc /usr/sbin/unbound
444 exit 0
445 fi
446
b8f5eda8 447 eval $(/usr/local/bin/readhash /var/ipfire/ethernet/settings)
d0e5f71f 448
b8f5eda8
MT
449 # Create control keys at first run
450 if [ ! -r "/etc/unbound/unbound_control.key" ]; then
451 unbound-control-setup -d /etc/unbound &>/dev/null
452 fi
453
454 # Update configuration files
b658a451 455 write_tuning_conf
b8f5eda8
MT
456 write_forward_conf
457
458 boot_mesg "Starting Unbound DNS Proxy..."
459 loadproc /usr/sbin/unbound || exit $?
460
f75c279b
AF
461 # Make own hostname resolveable
462 own_hostname
463
b8f5eda8
MT
464 # Update any known forwarding name servers
465 update_forwarders
36792be6
MT
466
467 # Update hosts
468 update_hosts
b8f5eda8 469 ;;
d0e5f71f
ML
470
471 stop)
b8f5eda8
MT
472 boot_mesg "Stopping Unbound DNS Proxy..."
473 killproc /usr/sbin/unbound
474 ;;
d0e5f71f
ML
475
476 restart)
b8f5eda8
MT
477 $0 stop
478 sleep 1
479 $0 start
480 ;;
d0e5f71f
ML
481
482 status)
b8f5eda8 483 statusproc /usr/sbin/unbound
b8f5eda8
MT
484 ;;
485
486 update-forwarders)
cd812106
MT
487 # Do not try updating forwarders when unbound is not running
488 if ! pgrep unbound &>/dev/null; then
489 exit 0
490 fi
491
b8f5eda8
MT
492 update_forwarders
493 ;;
d0e5f71f 494
b29c97b1
AF
495 test-name-server)
496 ns=${2}
497
498 test_name_server ${ns}
499 ret=${?}
500
501 case "${ret}" in
502 0)
503 echo "${ns} is validating"
504 ;;
505 2)
506 echo "${ns} is DNSSEC-aware"
507 ;;
508 3)
509 echo "${ns} is NOT DNSSEC-aware"
510 ;;
511 *)
512 echo "Test failed for an unknown reason"
8f3034d0 513 exit ${ret}
b29c97b1
AF
514 ;;
515 esac
516
517 if ns_supports_tcp ${ns}; then
518 echo "${ns} supports TCP fallback"
519 else
520 echo "${ns} does not support TCP fallback"
521 fi
522
8f3034d0
MT
523 edns_buffer_size=$(ns_determine_edns_buffer_size ${ns})
524 if [ -n "${edns_buffer_size}" ]; then
525 echo "EDNS buffer size for ${ns}: ${edns_buffer_size}"
526 fi
527
b29c97b1
AF
528 exit ${ret}
529 ;;
530
d0e5f71f 531 *)
b29c97b1 532 echo "Usage: $0 {start|stop|restart|status|update-forwarders|test-name-server}"
b8f5eda8
MT
533 exit 1
534 ;;
d0e5f71f
ML
535esac
536
537# End $rc_base/init.d/unbound