]> git.ipfire.org Git - ipfire-2.x.git/blame - src/initscripts/init.d/unbound
unbound: Fix for DNS forwarding of .local zones
[ipfire-2.x.git] / src / initscripts / init.d / 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
b8f5eda8 15USE_FORWARDERS=1
d0e5f71f 16
36792be6
MT
17# Cache any local zones for 60 seconds
18LOCAL_TTL=60
19
b8f5eda8
MT
20# Load optional configuration
21[ -e "/etc/sysconfig/unbound" ] && . /etc/sysconfig/unbound
d0e5f71f
ML
22
23function cidr() {
24 local cidr nbits IFS;
25 IFS=. read -r i1 i2 i3 i4 <<< ${1}
26 IFS=. read -r m1 m2 m3 m4 <<< ${2}
27 cidr=$(printf "%d.%d.%d.%d\n" "$((i1 & m1))" "$((i2 & m2))" "$((i3 & m3))" "$((i4 & m4))")
28 nbits=0
29 IFS=.
30 for dec in $2 ; do
31 case $dec in
32 255) let nbits+=8;;
33 254) let nbits+=7;;
34 252) let nbits+=6;;
35 248) let nbits+=5;;
36 240) let nbits+=4;;
37 224) let nbits+=3;;
38 192) let nbits+=2;;
39 128) let nbits+=1;;
40 0);;
41 *) echo "Error: $dec is not recognised"; exit 1
42 esac
43 done
44 echo "${cidr}/${nbits}"
45}
46
f75c279b
AF
47ip_address_revptr() {
48 local addr=${1}
49
50 local a1 a2 a3 a4
51 IFS=. read -r a1 a2 a3 a4 <<< ${addr}
52
53 echo "${a4}.${a3}.${a2}.${a1}.in-addr.arpa"
54}
55
b8f5eda8
MT
56read_name_servers() {
57 local i
58 for i in 1 2; do
59 echo "$(</var/ipfire/red/dns${i})"
60 done | xargs echo
61}
62
63config_header() {
64 echo "# This file is automatically generated and any changes"
65 echo "# will be overwritten. DO NOT EDIT!"
66 echo
67}
68
69update_forwarders() {
b29c97b1
AF
70 if [ "${USE_FORWARDERS}" = "1" -a -e "/var/ipfire/red/active" ]; then
71 local forwarders
72 local broken_forwarders
73
74 local ns
75 for ns in $(read_name_servers); do
76 test_name_server ${ns} &>/dev/null
77 case "$?" in
78 # Only use DNSSEC-validating or DNSSEC-aware name servers
79 0|2)
80 forwarders="${forwarders} ${ns}"
81 ;;
82 *)
83 broken_forwarders="${broken_forwarders} ${ns}"
84 ;;
85 esac
86 done
87
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}
91 echo_warning
92 fi
b8f5eda8 93
b29c97b1
AF
94 if [ -n "${broken_forwarders}" -a -z "${forwarders}" ]; then
95 boot_mesg "Falling back to recursor mode" ${WARNING}
96 echo_warning
b8f5eda8 97
b29c97b1
AF
98 elif [ -n "${forwarders}" ]; then
99 boot_mesg "Configuring upstream name server(s): ${forwarders:1}" ${INFO}
100 echo_ok
b8f5eda8 101
e24d6112 102 echo "${forwarders}" > /var/ipfire/red/dns
b29c97b1
AF
103 unbound-control -q forward ${forwarders}
104 return 0
105 fi
b8f5eda8 106 fi
b29c97b1
AF
107
108 # If forwarders cannot be used we run in recursor mode
e24d6112 109 echo "local recursor" > /var/ipfire/red/dns
b29c97b1 110 unbound-control -q forward off
b8f5eda8
MT
111}
112
f75c279b
AF
113own_hostname() {
114 local hostname=$(hostname -f)
0d7ca700 115 # 1.1.1.1 is reserved for unused green, skip this
f75c279b
AF
116 if [ -n "${GREEN_ADDRESS}" -a "${GREEN_ADDRESS}" != "1.1.1.1" ]; then
117 unbound-control -q local_data "${hostname} ${LOCAL_TTL} IN A ${GREEN_ADDRESS}"
118 fi
119
120 local address
121 for address in ${GREEN_ADDRESS} ${BLUE_ADDRESS} ${ORANGE_ADDRESS}; do
122 [ -n "${address}" ] || continue
123 [ "${address}" = "1.1.1.1" ] && continue
124
125 address=$(ip_address_revptr ${address})
126 unbound-control -q local_data "${address} ${LOCAL_TTL} IN PTR ${hostname}"
127 done
128}
129
36792be6
MT
130update_hosts() {
131 local enabled address hostname domainname
132
133 while IFS="," read -r enabled address hostname domainname; do
134 [ "${enabled}" = "on" ] || continue
135
136 # Build FQDN
137 local fqdn="${hostname}.${domainname}"
138
139 unbound-control -q local_data "${fqdn} ${LOCAL_TTL} IN A ${address}"
f75c279b 140
868d2a1f
MT
141 # Skip reverse resolution if the address equals the GREEN address
142 [ "${address}" = "${GREEN_ADDRESS}" ] && continue
143
f75c279b
AF
144 # Add RDNS
145 address=$(ip_address_revptr ${address})
146 unbound-control -q local_data "${address} ${LOCAL_TTL} IN PTR ${fqdn}"
36792be6
MT
147 done < /var/ipfire/main/hosts
148}
149
b8f5eda8
MT
150write_interfaces_conf() {
151 (
152 config_header
153
0d7ca700
AF
154 # 1.1.1.1 is reserved for unused green
155 if [ -n "${GREEN_ADDRESS}" -a "${GREEN_ADDRESS}" != "1.1.1.1" ]; then
d221f41f 156 echo "# allow access from GREEN"
b8f5eda8
MT
157 echo "access-control: $(cidr ${GREEN_NETADDRESS} ${GREEN_NETMASK}) allow"
158 fi
159
160 if [ -n "${BLUE_ADDRESS}" ]; then
d221f41f 161 echo "# allow access from BLUE"
b8f5eda8
MT
162 echo "access-control: $(cidr ${BLUE_NETADDRESS} ${BLUE_NETMASK}) allow"
163 fi
164 ) > /etc/unbound/interfaces.conf
165}
166
167write_forward_conf() {
168 (
169 config_header
170
f8aa041f
MT
171 local insecure_zones
172
b8f5eda8
MT
173 local enabled zone server remark
174 while IFS="," read -r enabled zone server remark; do
175 # Line must be enabled.
176 [ "${enabled}" = "on" ] || continue
177
f8aa041f
MT
178 # Zones that end with .local are commonly used for internal
179 # zones and therefore not signed
180 case "${zone}" in
181 *.local)
182 insecure_zones="${insecure_zones} ${zone}"
183 ;;
184 esac
185
b8f5eda8
MT
186 echo "forward-zone:"
187 echo " name: ${zone}"
188 echo " forward-addr: ${server}"
189 echo
190 done < /var/ipfire/dnsforward/config
f8aa041f
MT
191
192 if [ -n "${insecure_zones}" ]; then
193 echo "server:"
194
195 for zone in ${insecure_zones}; do
196 echo " domain-insecure: ${zone}"
197 done
198 fi
b8f5eda8
MT
199 ) > /etc/unbound/forward.conf
200}
201
b658a451
MT
202write_tuning_conf() {
203 # https://www.unbound.net/documentation/howto_optimise.html
204
205 # Determine number of online processors
206 local processors=$(getconf _NPROCESSORS_ONLN)
207
208 # Determine number of slabs
209 local slabs=1
210 while [ ${slabs} -lt ${processors} ]; do
211 slabs=$(( ${slabs} * 2 ))
212 done
213
214 # Determine amount of system memory
215 local mem=$(get_memory_amount)
216
217 # In the worst case scenario, unbound can use double the
218 # amount of memory allocated to a cache due to malloc overhead
219
220 # Large systems with more than 2GB of RAM
221 if [ ${mem} -ge 2048 ]; then
222 mem=128
223
224 # Small systems with less than 256MB of RAM
225 elif [ ${mem} -le 256 ]; then
226 mem=8
227
228 # Everything else
229 else
230 mem=32
231 fi
232
233 (
234 config_header
235
236 # We run one thread per processor
237 echo "num-threads: ${processors}"
238
239 # Adjust number of slabs
240 echo "infra-cache-slabs: ${slabs}"
241 echo "key-cache-slabs: ${slabs}"
242 echo "msg-cache-slabs: ${slabs}"
243 echo "rrset-cache-slabs: ${slabs}"
244
245 # Slice up the cache
246 echo "rrset-cache-size: $(( ${mem} / 2 ))m"
247 echo "msg-cache-size: $(( ${mem} / 4 ))m"
248 echo "key-cache-size: $(( ${mem} / 4 ))m"
249 ) > /etc/unbound/tuning.conf
250}
251
252get_memory_amount() {
253 local key val unit
254
255 while read -r key val unit; do
256 case "${key}" in
257 MemTotal:*)
258 # Convert to MB
259 echo "$(( ${val} / 1024 ))"
260 break
261 ;;
262 esac
263 done < /proc/meminfo
264}
b8f5eda8 265
b29c97b1
AF
266test_name_server() {
267 local ns=${1}
268
269 # Return codes:
270 # 0 DNSSEC validating
271 # 1 Error: unreachable, etc.
272 # 2 DNSSEC aware
273 # 3 NOT DNSSEC-aware
274
275 # Exit when the server is not reachable
276 ns_is_online ${ns} || return 1
277
278 # Return 0 if validating
279 ns_is_validating ${ns} && return 0
280
281 local errors
282 for rr in DNSKEY DS RRSIG; do
283 if ! ns_forwards_${rr} ${ns}; then
284 errors="${errors} ${rr}"
285 fi
286 done
287
288 if [ -n "${errors}" ]; then
289 echo >&2 "Unable to retrieve the following resource records from ${ns}: ${errors:1}"
290 return 3
291 fi
292
293 # Is DNSSEC-aware
294 return 2
295}
296
297# Sends an A query to the nameserver w/o DNSSEC
298ns_is_online() {
299 local ns=${1}
300
301 dig @${ns} +nodnssec A ${TEST_DOMAIN} >/dev/null
302}
303
304# Resolving ${TEST_DOMAIN_FAIL} will fail if the nameserver is validating
305ns_is_validating() {
306 local ns=${1}
307
308 dig @${ns} A ${TEST_DOMAIN_FAIL} | grep -q SERVFAIL
309}
310
311# Checks if we can retrieve the DNSKEY for this domain.
312# dig will print the SOA if nothing was found
313ns_forwards_DNSKEY() {
314 local ns=${1}
315
316 dig @${ns} DNSKEY ${TEST_DOMAIN} | grep -qv SOA
317}
318
319ns_forwards_DS() {
320 local ns=${1}
321
322 dig @${ns} DS ${TEST_DOMAIN} | grep -qv SOA
323}
324
325ns_forwards_RRSIG() {
326 local ns=${1}
327
328 dig @${ns} +dnssec A ${TEST_DOMAIN} | grep -q RRSIG
329}
330
331ns_supports_tcp() {
332 local ns=${1}
333
334 dig @${ns} +tcp A ${TEST_DOMAIN} >/dev/null || return 1
335}
336
d0e5f71f
ML
337case "$1" in
338 start)
80bc6022
MT
339 # Print a nicer messagen when unbound is already running
340 if pidofproc -s unbound; then
341 statusproc /usr/sbin/unbound
342 exit 0
343 fi
344
b8f5eda8 345 eval $(/usr/local/bin/readhash /var/ipfire/ethernet/settings)
d0e5f71f 346
b8f5eda8
MT
347 # Create control keys at first run
348 if [ ! -r "/etc/unbound/unbound_control.key" ]; then
349 unbound-control-setup -d /etc/unbound &>/dev/null
350 fi
351
352 # Update configuration files
b658a451 353 write_tuning_conf
b8f5eda8
MT
354 write_interfaces_conf
355 write_forward_conf
356
357 boot_mesg "Starting Unbound DNS Proxy..."
358 loadproc /usr/sbin/unbound || exit $?
359
f75c279b
AF
360 # Make own hostname resolveable
361 own_hostname
362
b8f5eda8
MT
363 # Update any known forwarding name servers
364 update_forwarders
36792be6
MT
365
366 # Update hosts
367 update_hosts
b8f5eda8 368 ;;
d0e5f71f
ML
369
370 stop)
b8f5eda8
MT
371 boot_mesg "Stopping Unbound DNS Proxy..."
372 killproc /usr/sbin/unbound
373 ;;
d0e5f71f
ML
374
375 restart)
b8f5eda8
MT
376 $0 stop
377 sleep 1
378 $0 start
379 ;;
d0e5f71f
ML
380
381 status)
b8f5eda8 382 statusproc /usr/sbin/unbound
b8f5eda8
MT
383 ;;
384
385 update-forwarders)
386 update_forwarders
387 ;;
d0e5f71f 388
b29c97b1
AF
389 test-name-server)
390 ns=${2}
391
392 test_name_server ${ns}
393 ret=${?}
394
395 case "${ret}" in
396 0)
397 echo "${ns} is validating"
398 ;;
399 2)
400 echo "${ns} is DNSSEC-aware"
401 ;;
402 3)
403 echo "${ns} is NOT DNSSEC-aware"
404 ;;
405 *)
406 echo "Test failed for an unknown reason"
407 ;;
408 esac
409
410 if ns_supports_tcp ${ns}; then
411 echo "${ns} supports TCP fallback"
412 else
413 echo "${ns} does not support TCP fallback"
414 fi
415
416 exit ${ret}
417 ;;
418
d0e5f71f 419 *)
b29c97b1 420 echo "Usage: $0 {start|stop|restart|status|update-forwarders|test-name-server}"
b8f5eda8
MT
421 exit 1
422 ;;
d0e5f71f
ML
423esac
424
425# End $rc_base/init.d/unbound