2 ##############################################################################
4 # This program is free software; you can redistribute it and/or modify
5 # it under the terms of the GNU General Public License version 2 as
6 # published by the Free Software Foundation.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # Copyright (C) 2016 Eric Luehrsen
15 ##############################################################################
17 # This builds the basic UCI components currently supported for Unbound. It is
18 # intentionally NOT comprehensive and bundles a lot of options. The UCI is to
19 # be a simpler presentation of the total Unbound conf set.
21 ##############################################################################
35 UNBOUND_D_RESOURCE
=small
36 UNBOUND_D_RECURSION
=passive
38 UNBOUND_TXT_FWD_ZONE
=""
41 UNBOUND_N_EDNS_SIZE
=1280
42 UNBOUND_N_FWD_PORTS
=""
46 ##############################################################################
48 UNBOUND_ANCHOR
=/usr
/bin
/unbound-anchor
49 UNBOUND_CONTROL
=/usr
/bin
/unbound-control
51 UNBOUND_LIBDIR
=/usr
/lib
/unbound
53 UNBOUND_PIDFILE
=/var
/run
/unbound.pid
55 UNBOUND_VARDIR
=/var
/lib
/unbound
56 UNBOUND_CONFFILE
=$UNBOUND_VARDIR/unbound.conf
57 UNBOUND_KEYFILE
=$UNBOUND_VARDIR/root.key
58 UNBOUND_HINTFILE
=$UNBOUND_VARDIR/root.hints
59 UNBOUND_TIMEFILE
=$UNBOUND_VARDIR/unbound.
time
60 UNBOUND_CHECKFILE
=$UNBOUND_VARDIR/unbound.check
62 ##############################################################################
65 .
/lib
/functions
/network.sh
67 .
$UNBOUND_LIBDIR/dnsmasq.sh
68 .
$UNBOUND_LIBDIR/iptools.sh
69 .
$UNBOUND_LIBDIR/rootzone.sh
71 ##############################################################################
73 create_access_control
() {
75 local subnets subnets4 subnets6
76 local validip4 validip6
78 network_get_subnets subnets4
"$cfg"
79 network_get_subnets6 subnets6
"$cfg"
80 subnets
="$subnets4 $subnets6"
83 if [ -n "$subnets" ] ; then
84 for subnet
in $subnets ; do
85 validip4
=$
( valid_subnet4
$subnet )
86 validip6
=$
( valid_subnet6
$subnet )
89 if [ "$validip4" = "ok" -o "$validip6" = "ok" ] ; then
90 # For each "network" UCI add "access-control:" white list for queries
91 echo " access-control: $subnet allow" >> $UNBOUND_CONFFILE
97 ##############################################################################
99 create_domain_insecure
() {
100 echo " domain-insecure: \"$1\"" >> $UNBOUND_CONFFILE
103 ##############################################################################
106 mkdir
-p $UNBOUND_VARDIR
107 touch $UNBOUND_CONFFILE
110 if [ -f /etc
/unbound
/root.hints
] ; then
111 # Your own local copy of root.hints
112 cp -p /etc
/unbound
/root.hints
$UNBOUND_HINTFILE
114 elif [ -f /usr
/share
/dns
/root.hints
] ; then
115 # Debian-like package dns-root-data
116 cp -p /usr
/share
/dns
/root.hints
$UNBOUND_HINTFILE
119 logger
-t unbound
-s "iterator will use built-in root hints"
123 if [ -f /etc
/unbound
/root.key
] ; then
124 # Your own local copy of a root.key
125 cp -p /etc
/unbound
/root.key
$UNBOUND_KEYFILE
127 elif [ -f /usr
/share
/dns
/root.key
] ; then
128 # Debian-like package dns-root-data
129 cp -p /usr
/share
/dns
/root.key
$UNBOUND_KEYFILE
131 elif [ -x "$UNBOUND_ANCHOR" ] ; then
132 $UNBOUND_ANCHOR -a $UNBOUND_KEYFILE
135 logger
-t unbound
-s "validator will use built-in trust anchor"
139 ##############################################################################
146 # Make fresh conf file
147 echo "# $UNBOUND_CONFFILE generated by UCI $( date )"
149 } > $UNBOUND_CONFFILE
152 if [ "$UNBOUND_B_CONTROL" -gt 0 ] ; then
154 # Enable remote control tool, but only at local host for security
155 echo "remote-control:"
156 echo " control-enable: yes"
157 echo " control-use-cert: no"
158 echo " control-interface: 127.0.0.1"
159 echo " control-interface: ::1"
161 } >> $UNBOUND_CONFFILE
165 # "control:" clause is seperate before "server:" so we can append
166 # dnsmasq "server:" parts and "forward:" cluases towards the end.
167 echo "remote-control:"
168 echo " control-enable: no"
170 } >> $UNBOUND_CONFFILE
177 echo " username: unbound"
178 echo " num-threads: 1"
179 echo " msg-cache-slabs: 1"
180 echo " rrset-cache-slabs: 1"
181 echo " infra-cache-slabs: 1"
182 echo " key-cache-slabs: 1"
184 } >> $UNBOUND_CONFFILE
190 echo " statistics-interval: 0"
191 echo " statistics-cumulative: no"
192 echo " extended-statistics: no"
194 } >> $UNBOUND_CONFFILE
198 # Interfaces (access contol "option local_service")
199 echo " interface: 0.0.0.0"
200 echo " interface: ::0"
201 echo " outgoing-interface: 0.0.0.0"
202 echo " outgoing-interface: ::0"
204 } >> $UNBOUND_CONFFILE
208 # protocol level tuning
209 echo " edns-buffer-size: $UNBOUND_N_EDNS_SIZE"
210 echo " msg-buffer-size: 8192"
211 echo " port: $UNBOUND_N_RX_PORT"
212 echo " outgoing-port-permit: 10240-65535"
214 } >> $UNBOUND_CONFFILE
218 # Other harding and options for an embedded router
219 echo " harden-short-bufsize: yes"
220 echo " harden-large-queries: yes"
221 echo " harden-glue: yes"
222 echo " harden-below-nxdomain: no"
223 echo " harden-referral-path: no"
224 echo " use-caps-for-id: no"
226 } >> $UNBOUND_CONFFILE
231 echo " use-syslog: yes"
232 echo " chroot: \"$UNBOUND_VARDIR\""
233 echo " directory: \"$UNBOUND_VARDIR\""
234 echo " pidfile: \"$UNBOUND_PIDFILE\""
235 } >> $UNBOUND_CONFFILE
238 if [ -f "$UNBOUND_HINTFILE" ] ; then
239 # Optional hints if found
240 echo " root-hints: \"$UNBOUND_HINTFILE\"" >> $UNBOUND_CONFFILE
244 if [ "$UNBOUND_B_DNSSEC" -gt 0 -a -f "$UNBOUND_KEYFILE" ] ; then
246 echo " auto-trust-anchor-file: \"$UNBOUND_KEYFILE\""
248 } >> $UNBOUND_CONFFILE
251 echo >> $UNBOUND_CONFFILE
255 case "$UNBOUND_D_RESOURCE" in
256 # Tiny - Unbound's recommended cheap hardware config
257 tiny
) rt_mem
=1 ; rt_conn
=1 ;;
258 # Small - Half RRCACHE and open ports
259 small
) rt_mem
=8 ; rt_conn
=5 ;;
260 # Medium - Nearly default but with some added balancintg
261 medium
) rt_mem
=16 ; rt_conn
=10 ;;
262 # Large - Double medium
263 large
) rt_mem
=32 ; rt_conn
=10 ;;
264 # Whatever unbound does
265 *) rt_mem
=0 ; rt_conn
=0 ;;
269 if [ "$rt_mem" -gt 0 ] ; then
271 # Set memory sizing parameters
272 echo " outgoing-range: $(($rt_conn*64))"
273 echo " num-queries-per-thread: $(($rt_conn*32))"
274 echo " outgoing-num-tcp: $(($rt_conn))"
275 echo " incoming-num-tcp: $(($rt_conn))"
276 echo " rrset-cache-size: $(($rt_mem*256))k"
277 echo " msg-cache-size: $(($rt_mem*128))k"
278 echo " key-cache-size: $(($rt_mem*128))k"
279 echo " neg-cache-size: $(($rt_mem*64))k"
280 echo " infra-cache-numhosts: $(($rt_mem*256))"
282 } >> $UNBOUND_CONFFILE
285 logger
-t unbound
-s "default memory resource consumption"
289 if [ "$UNBOUND_B_DNSSEC" -gt 0 ] ; then
290 if [ ! -f "$UNBOUND_TIMEFILE" -a "$UNBOUND_B_NTP_BOOT" -gt 0 ] ; then
291 # DNSSEC chicken and egg with getting NTP time
292 echo " val-override-date: -1" >> $UNBOUND_CONFFILE
297 # Validation of DNSSEC
298 echo " module-config: \"validator iterator\""
299 echo " harden-dnssec-stripped: yes"
300 echo " val-clean-additional: yes"
301 echo " ignore-cd-flag: yes"
303 } >> $UNBOUND_CONFFILE
307 # Just iteration without DNSSEC
308 echo " module-config: \"iterator\""
310 } >> $UNBOUND_CONFFILE
314 if [ "$UNBOUND_B_QUERY_MIN" -gt 0 ] ; then
315 # Minor improvement on query privacy
316 echo " qname-minimisation: yes" >> $UNBOUND_CONFFILE
319 echo " qname-minimisation: no" >> $UNBOUND_CONFFILE
323 case "$UNBOUND_D_RECURSION" in
327 echo " prefetch-key: no"
328 echo " target-fetch-policy: \"0 0 0 0 0\""
330 } >> $UNBOUND_CONFFILE
335 echo " prefetch: yes"
336 echo " prefetch-key: yes"
337 echo " target-fetch-policy: \"3 2 1 0 0\""
339 } >> $UNBOUND_CONFFILE
343 logger
-t unbound
-s "default recursion configuration"
349 # Reload records more than 10 hours old
350 # DNSSEC 5 minute bogus cool down before retry
351 # Adaptive infrastructure info kept for 15 minutes
352 echo " cache-min-ttl: $UNBOUND_TTL_MIN"
353 echo " cache-max-ttl: 36000"
354 echo " val-bogus-ttl: 300"
355 echo " infra-host-ttl: 900"
357 } >> $UNBOUND_CONFFILE
360 if [ "$UNBOUND_B_PRIV_BLCK" -gt 0 ] ; then
362 # Remove DNS reponses from upstream with private IP
363 echo " private-address: 10.0.0.0/8"
364 echo " private-address: 169.254.0.0/16"
365 echo " private-address: 172.16.0.0/12"
366 echo " private-address: 192.168.0.0/16"
367 echo " private-address: fc00::/8"
368 echo " private-address: fd00::/8"
369 echo " private-address: fe80::/10"
370 } >> $UNBOUND_CONFFILE
374 if [ "$UNBOUND_B_LOCL_BLCK" -gt 0 ] ; then
376 # Remove DNS reponses from upstream with loopback IP
377 # Black hole DNS method for ad blocking, so consider...
378 echo " private-address: 127.0.0.0/8"
379 echo " private-address: ::1/128"
381 } >> $UNBOUND_CONFFILE
384 echo >> $UNBOUND_CONFFILE
389 config_list_foreach
"$cfg" "domain_insecure" create_domain_insecure
390 echo >> $UNBOUND_CONFFILE
398 if [ "$UNBOUND_B_LOCL_SERV" -gt 0 ] ; then
399 # Only respond to queries from which this device has an interface.
400 # Prevent DNS amplification attacks by not responding to the universe.
402 config_foreach create_access_control interface
405 echo " access-control: 127.0.0.0/8 allow"
406 echo " access-control: ::1/128 allow"
407 echo " access-control: fe80::/10 allow"
409 } >> $UNBOUND_CONFFILE
413 echo " access-control: 0.0.0.0/0 allow"
414 echo " access-control: ::0/0 allow"
416 } >> $UNBOUND_CONFFILE
420 ##############################################################################
430 config_get_bool UNBOUND_B_GATE_NAME
"$cfg" dnsmsaq_gate_name
0
431 config_get_bool UNBOUND_B_DNSMASQ
"$cfg" dnsmasq_link_dns
0
432 config_get_bool UNBOUND_B_LOCL_NAME
"$cfg" dnsmasq_only_local
0
433 config_get_bool UNBOUND_B_LOCL_SERV
"$cfg" localservice
1
434 config_get_bool UNBOUND_B_MAN_CONF
"$cfg" manual_conf
0
435 config_get_bool UNBOUND_B_QUERY_MIN
"$cfg" query_minimize
0
436 config_get_bool UNBOUND_B_PRIV_BLCK
"$cfg" rebind_protection
1
437 config_get_bool UNBOUND_B_LOCL_BLCK
"$cfg" rebind_localhost
0
438 config_get_bool UNBOUND_B_CONTROL
"$cfg" unbound_control
0
439 config_get_bool UNBOUND_B_DNSSEC
"$cfg" validator
0
440 config_get_bool UNBOUND_B_NTP_BOOT
"$cfg" validator_ntp
1
442 config_get UNBOUND_N_EDNS_SIZE
"$cfg" edns_size
1280
443 config_get UNBOUND_N_RX_PORT
"$cfg" listen_port
53
444 config_get UNBOUND_D_RECURSION
"$cfg" recursion passive
445 config_get UNBOUND_D_RESOURCE
"$cfg" resource small
446 config_get UNBOUND_N_ROOT_AGE
"$cfg" root_age
7
447 config_get UNBOUND_TTL_MIN
"$cfg" ttl_min
120
450 if [ "$UNBOUND_B_DNSMASQ" -gt 0 ] ; then
451 dnsmasqpath
=$
( which dnsmasq
)
454 if [ ! -x "$dnsmasqpath" ] ; then
455 logger
-t unbound
-s "cannot forward to dnsmasq"
461 if [ "$UNBOUND_N_EDNS_SIZE" -lt 512 \
462 -o 4096 -lt "$UNBOUND_N_EDNS_SIZE" ] ; then
463 # exceeds range, back to default
464 UNBOUND_N_EDNS_SIZE
=1280
468 if [ "$UNBOUND_N_RX_PORT" -lt 1024 \
469 -o 10240 -lt "$UNBOUND_N_RX_PORT" ] ; then
470 # special port or in 5 digits, back to default
475 if [ "$UNBOUND_TTL_MIN" -gt 1800 ] ; then
476 # that could have had awful side effects
481 if [ "$UNBOUND_B_MAN_CONF" -gt 0 ] ; then
482 # Don't want this being triggered. Maybe we could, but then the
483 # base conf you provide would need to be just right.
491 ##############################################################################
496 echo "# $UNBOUND_CHECKFILE generated by UCI $( date )"
499 } > $UNBOUND_CHECKFILE
502 if [ "$UNBOUND_B_MAN_CONF" -gt 0 ] ; then
503 # You are doing your own thing, so just copy /etc/ to /var/
504 cp -p /etc
/unbound
/* $UNBOUND_VARDIR/
508 # Ensure access and prepare to jail
509 chown
-R unbound
:unbound
$UNBOUND_VARDIR
510 chmod 775 $UNBOUND_VARDIR
511 chmod 664 $UNBOUND_VARDIR/*
514 ##############################################################################
517 # Make a home for Unbound in /var/lib/unbound
520 # Load up the chunks of UCI
522 config_foreach unbound_uci unbound
524 # Unbound primary DNS, and dnsmasq side service DHCP-DNS (dnsmasq.sh)
527 # Unbound needs chroot ownership
531 ##############################################################################