]>
Commit | Line | Data |
---|---|---|
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 |
10 | TEST_DOMAIN="ipfire.org" |
11 | ||
12 | # This domain will never validate | |
13 | TEST_DOMAIN_FAIL="dnssec-failed.org" | |
14 | ||
b8f5eda8 | 15 | USE_FORWARDERS=1 |
d0e5f71f | 16 | |
36792be6 MT |
17 | # Cache any local zones for 60 seconds |
18 | LOCAL_TTL=60 | |
19 | ||
b8f5eda8 MT |
20 | # Load optional configuration |
21 | [ -e "/etc/sysconfig/unbound" ] && . /etc/sysconfig/unbound | |
d0e5f71f ML |
22 | |
23 | function 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 |
47 | ip_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 |
56 | read_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 | ||
63 | config_header() { | |
64 | echo "# This file is automatically generated and any changes" | |
65 | echo "# will be overwritten. DO NOT EDIT!" | |
66 | echo | |
67 | } | |
68 | ||
69 | update_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 |
113 | own_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 |
130 | update_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 AF |
140 | |
141 | # Add RDNS | |
142 | address=$(ip_address_revptr ${address}) | |
143 | unbound-control -q local_data "${address} ${LOCAL_TTL} IN PTR ${fqdn}" | |
36792be6 MT |
144 | done < /var/ipfire/main/hosts |
145 | } | |
146 | ||
b8f5eda8 MT |
147 | write_interfaces_conf() { |
148 | ( | |
149 | config_header | |
150 | ||
0d7ca700 AF |
151 | # 1.1.1.1 is reserved for unused green |
152 | if [ -n "${GREEN_ADDRESS}" -a "${GREEN_ADDRESS}" != "1.1.1.1" ]; then | |
d221f41f | 153 | echo "# allow access from GREEN" |
b8f5eda8 MT |
154 | echo "access-control: $(cidr ${GREEN_NETADDRESS} ${GREEN_NETMASK}) allow" |
155 | fi | |
156 | ||
157 | if [ -n "${BLUE_ADDRESS}" ]; then | |
d221f41f | 158 | echo "# allow access from BLUE" |
b8f5eda8 MT |
159 | echo "access-control: $(cidr ${BLUE_NETADDRESS} ${BLUE_NETMASK}) allow" |
160 | fi | |
161 | ) > /etc/unbound/interfaces.conf | |
162 | } | |
163 | ||
164 | write_forward_conf() { | |
165 | ( | |
166 | config_header | |
167 | ||
168 | local enabled zone server remark | |
169 | while IFS="," read -r enabled zone server remark; do | |
170 | # Line must be enabled. | |
171 | [ "${enabled}" = "on" ] || continue | |
172 | ||
173 | echo "forward-zone:" | |
174 | echo " name: ${zone}" | |
175 | echo " forward-addr: ${server}" | |
176 | echo | |
177 | done < /var/ipfire/dnsforward/config | |
178 | ) > /etc/unbound/forward.conf | |
179 | } | |
180 | ||
b658a451 MT |
181 | write_tuning_conf() { |
182 | # https://www.unbound.net/documentation/howto_optimise.html | |
183 | ||
184 | # Determine number of online processors | |
185 | local processors=$(getconf _NPROCESSORS_ONLN) | |
186 | ||
187 | # Determine number of slabs | |
188 | local slabs=1 | |
189 | while [ ${slabs} -lt ${processors} ]; do | |
190 | slabs=$(( ${slabs} * 2 )) | |
191 | done | |
192 | ||
193 | # Determine amount of system memory | |
194 | local mem=$(get_memory_amount) | |
195 | ||
196 | # In the worst case scenario, unbound can use double the | |
197 | # amount of memory allocated to a cache due to malloc overhead | |
198 | ||
199 | # Large systems with more than 2GB of RAM | |
200 | if [ ${mem} -ge 2048 ]; then | |
201 | mem=128 | |
202 | ||
203 | # Small systems with less than 256MB of RAM | |
204 | elif [ ${mem} -le 256 ]; then | |
205 | mem=8 | |
206 | ||
207 | # Everything else | |
208 | else | |
209 | mem=32 | |
210 | fi | |
211 | ||
212 | ( | |
213 | config_header | |
214 | ||
215 | # We run one thread per processor | |
216 | echo "num-threads: ${processors}" | |
217 | ||
218 | # Adjust number of slabs | |
219 | echo "infra-cache-slabs: ${slabs}" | |
220 | echo "key-cache-slabs: ${slabs}" | |
221 | echo "msg-cache-slabs: ${slabs}" | |
222 | echo "rrset-cache-slabs: ${slabs}" | |
223 | ||
224 | # Slice up the cache | |
225 | echo "rrset-cache-size: $(( ${mem} / 2 ))m" | |
226 | echo "msg-cache-size: $(( ${mem} / 4 ))m" | |
227 | echo "key-cache-size: $(( ${mem} / 4 ))m" | |
228 | ) > /etc/unbound/tuning.conf | |
229 | } | |
230 | ||
231 | get_memory_amount() { | |
232 | local key val unit | |
233 | ||
234 | while read -r key val unit; do | |
235 | case "${key}" in | |
236 | MemTotal:*) | |
237 | # Convert to MB | |
238 | echo "$(( ${val} / 1024 ))" | |
239 | break | |
240 | ;; | |
241 | esac | |
242 | done < /proc/meminfo | |
243 | } | |
b8f5eda8 | 244 | |
b29c97b1 AF |
245 | test_name_server() { |
246 | local ns=${1} | |
247 | ||
248 | # Return codes: | |
249 | # 0 DNSSEC validating | |
250 | # 1 Error: unreachable, etc. | |
251 | # 2 DNSSEC aware | |
252 | # 3 NOT DNSSEC-aware | |
253 | ||
254 | # Exit when the server is not reachable | |
255 | ns_is_online ${ns} || return 1 | |
256 | ||
257 | # Return 0 if validating | |
258 | ns_is_validating ${ns} && return 0 | |
259 | ||
260 | local errors | |
261 | for rr in DNSKEY DS RRSIG; do | |
262 | if ! ns_forwards_${rr} ${ns}; then | |
263 | errors="${errors} ${rr}" | |
264 | fi | |
265 | done | |
266 | ||
267 | if [ -n "${errors}" ]; then | |
268 | echo >&2 "Unable to retrieve the following resource records from ${ns}: ${errors:1}" | |
269 | return 3 | |
270 | fi | |
271 | ||
272 | # Is DNSSEC-aware | |
273 | return 2 | |
274 | } | |
275 | ||
276 | # Sends an A query to the nameserver w/o DNSSEC | |
277 | ns_is_online() { | |
278 | local ns=${1} | |
279 | ||
280 | dig @${ns} +nodnssec A ${TEST_DOMAIN} >/dev/null | |
281 | } | |
282 | ||
283 | # Resolving ${TEST_DOMAIN_FAIL} will fail if the nameserver is validating | |
284 | ns_is_validating() { | |
285 | local ns=${1} | |
286 | ||
287 | dig @${ns} A ${TEST_DOMAIN_FAIL} | grep -q SERVFAIL | |
288 | } | |
289 | ||
290 | # Checks if we can retrieve the DNSKEY for this domain. | |
291 | # dig will print the SOA if nothing was found | |
292 | ns_forwards_DNSKEY() { | |
293 | local ns=${1} | |
294 | ||
295 | dig @${ns} DNSKEY ${TEST_DOMAIN} | grep -qv SOA | |
296 | } | |
297 | ||
298 | ns_forwards_DS() { | |
299 | local ns=${1} | |
300 | ||
301 | dig @${ns} DS ${TEST_DOMAIN} | grep -qv SOA | |
302 | } | |
303 | ||
304 | ns_forwards_RRSIG() { | |
305 | local ns=${1} | |
306 | ||
307 | dig @${ns} +dnssec A ${TEST_DOMAIN} | grep -q RRSIG | |
308 | } | |
309 | ||
310 | ns_supports_tcp() { | |
311 | local ns=${1} | |
312 | ||
313 | dig @${ns} +tcp A ${TEST_DOMAIN} >/dev/null || return 1 | |
314 | } | |
315 | ||
d0e5f71f ML |
316 | case "$1" in |
317 | start) | |
80bc6022 MT |
318 | # Print a nicer messagen when unbound is already running |
319 | if pidofproc -s unbound; then | |
320 | statusproc /usr/sbin/unbound | |
321 | exit 0 | |
322 | fi | |
323 | ||
b8f5eda8 | 324 | eval $(/usr/local/bin/readhash /var/ipfire/ethernet/settings) |
d0e5f71f | 325 | |
b8f5eda8 MT |
326 | # Create control keys at first run |
327 | if [ ! -r "/etc/unbound/unbound_control.key" ]; then | |
328 | unbound-control-setup -d /etc/unbound &>/dev/null | |
329 | fi | |
330 | ||
331 | # Update configuration files | |
b658a451 | 332 | write_tuning_conf |
b8f5eda8 MT |
333 | write_interfaces_conf |
334 | write_forward_conf | |
335 | ||
336 | boot_mesg "Starting Unbound DNS Proxy..." | |
337 | loadproc /usr/sbin/unbound || exit $? | |
338 | ||
f75c279b AF |
339 | # Make own hostname resolveable |
340 | own_hostname | |
341 | ||
b8f5eda8 MT |
342 | # Update any known forwarding name servers |
343 | update_forwarders | |
36792be6 MT |
344 | |
345 | # Update hosts | |
346 | update_hosts | |
b8f5eda8 | 347 | ;; |
d0e5f71f ML |
348 | |
349 | stop) | |
b8f5eda8 MT |
350 | boot_mesg "Stopping Unbound DNS Proxy..." |
351 | killproc /usr/sbin/unbound | |
352 | ;; | |
d0e5f71f ML |
353 | |
354 | restart) | |
b8f5eda8 MT |
355 | $0 stop |
356 | sleep 1 | |
357 | $0 start | |
358 | ;; | |
d0e5f71f ML |
359 | |
360 | status) | |
b8f5eda8 | 361 | statusproc /usr/sbin/unbound |
b8f5eda8 MT |
362 | ;; |
363 | ||
364 | update-forwarders) | |
365 | update_forwarders | |
366 | ;; | |
d0e5f71f | 367 | |
b29c97b1 AF |
368 | test-name-server) |
369 | ns=${2} | |
370 | ||
371 | test_name_server ${ns} | |
372 | ret=${?} | |
373 | ||
374 | case "${ret}" in | |
375 | 0) | |
376 | echo "${ns} is validating" | |
377 | ;; | |
378 | 2) | |
379 | echo "${ns} is DNSSEC-aware" | |
380 | ;; | |
381 | 3) | |
382 | echo "${ns} is NOT DNSSEC-aware" | |
383 | ;; | |
384 | *) | |
385 | echo "Test failed for an unknown reason" | |
386 | ;; | |
387 | esac | |
388 | ||
389 | if ns_supports_tcp ${ns}; then | |
390 | echo "${ns} supports TCP fallback" | |
391 | else | |
392 | echo "${ns} does not support TCP fallback" | |
393 | fi | |
394 | ||
395 | exit ${ret} | |
396 | ;; | |
397 | ||
d0e5f71f | 398 | *) |
b29c97b1 | 399 | echo "Usage: $0 {start|stop|restart|status|update-forwarders|test-name-server}" |
b8f5eda8 MT |
400 | exit 1 |
401 | ;; | |
d0e5f71f ML |
402 | esac |
403 | ||
404 | # End $rc_base/init.d/unbound |