2 # function library used by adblock-update.sh
3 # written by Dirk Brenken (dev@brenken.org)
5 # f_envload: load adblock environment
9 # source in system function library
11 if [ -r "/lib/functions.sh" ]
16 f_log
"system function library not found" "${rc}"
20 # source in system network library
22 if [ -r "/lib/functions/network.sh" ]
24 .
"/lib/functions/network.sh"
27 f_log
"system network library not found" "${rc}"
31 # set initial defaults,
32 # may be overwritten by setting appropriate adblock config options in global section of /etc/config/adblock
36 adb_nullipv4
="192.0.2.1"
37 adb_nullipv6
="::ffff:c000:0201"
38 adb_whitelist
="/etc/adblock/adblock.whitelist"
39 adb_whitelist_rset
="\$1 ~/^([A-Za-z0-9_-]+\.){1,}[A-Za-z]+/{print tolower(\$1)}"
43 # function to parse global section by callback
48 if [ "${type}" = "adblock" ]
54 eval "${option}=\"${value}\""
61 # function to parse 'service' and 'source' sections
65 local value opt section
="${1}" options
="adb_dir adb_src adb_src_rset adb_src_cat"
66 config_get switch
"${section}" "enabled"
67 if [ "${switch}" = "1" ]
69 if [ "${section}" != "backup" ]
71 eval "adb_sources=\"${adb_sources} ${section}\""
75 config_get value
"${section}" "${opt}"
78 eval "${opt}_${section}=\"${value}\""
84 # check opkg availability
86 if [ -r "/var/lock/opkg.lock" ]
89 f_log
"adblock installation finished successfully, 'opkg' currently locked by package installer"
93 # get list with all installed packages
95 pkg_list
="$(opkg list-installed)"
96 if [ -z "${pkg_list}" ]
99 f_log
"empty package list" "${rc}"
103 # load adblock config and start parsing functions
106 config_foreach parse_config service
107 config_foreach parse_config
source
109 # set more script defaults (can't be overwritten by adblock config options)
112 adb_tmpfile
="$(mktemp -tu)"
113 adb_tmpdir
="$(mktemp -p /tmp -d)"
114 adb_dnsdir
="/tmp/dnsmasq.d"
115 adb_dnshidedir
="${adb_dnsdir}/.adb_hidden"
116 adb_dnsprefix
="adb_list"
117 adb_uci
="$(which uci)"
118 adb_iptv4
="$(which iptables)"
119 adb_iptv6
="$(which ip6tables)"
120 adb_fetch
="$(which wget)"
121 unset adb_srclist adb_revsrclist adb_errsrclist
123 # check 'enabled' & 'version' config options
125 if [ -z "${adb_enabled}" ] || [ -z "${adb_cfgver}" ] || [ "${adb_cfgver%%.*}" != "${adb_mincfgver%%.*}" ]
128 f_log
"outdated adblock config (${adb_mincfgver} vs. ${adb_cfgver}), please use latest version from '/etc/adblock/adblock.conf.default'"
130 elif [ "${adb_cfgver#*.}" != "${adb_mincfgver#*.}" ]
134 if [ $
((adb_enabled
)) -ne 1 ]
137 f_log
"adblock is currently disabled, please set adblock.global.adb_enabled=1' to use this service"
141 # check running dnsmasq instance
143 rc
="$(ps | grep -q "[d
]nsmasq
"; printf ${?})"
147 f_log
"please enable the local dnsmasq instance to use adblock"
151 # check running firewall
153 check
="$(${adb_iptv4} -vnL | grep -F "DROP
")"
157 f_log
"please enable the local firewall to use adblock"
161 # get lan ip addresses
163 network_get_ipaddr adb_ipv4
"${adb_lanif}"
164 network_get_ipaddr6 adb_ipv6
"${adb_lanif}"
165 if [ -z "${adb_ipv4}" ] && [ -z "${adb_ipv6}" ]
168 f_log
"no valid IPv4/IPv6 configuration found (${adb_lanif}), please set 'adb_lanif' manually"
172 # check logical update interfaces (with default route)
174 network_find_wan adb_wanif4
175 network_find_wan6 adb_wanif6
176 if [ -z "${adb_wanif4}" ] && [ -z "${adb_wanif6}" ]
178 adb_wanif4
="${adb_lanif}"
183 if [ "${adb_wanif4}" = "${adb_lanif}" ] || [ "${adb_wanif6}" = "${adb_lanif}" ]
185 adb_nullipv4
="${adb_ipv4}"
186 adb_nullipv6
="${adb_ipv6}"
187 if [ "$(uci get uhttpd.main.listen_http | grep -Fo "80")" = "80" ] ||
188 [ "$(uci get uhttpd.main.listen_https | grep -Fo "443")" = "443" ]
191 f_log
"AP mode detected, set local LuCI instance to ports <> 80/443"
198 # get system release level
200 adb_sysver
="$(printf "${pkg_list}" | grep "^base-files
-")"
201 adb_sysver
="${adb_sysver##*-}"
204 # f_envcheck: check/set environment prerequisites
210 if [ "${outdate_ok}" = "true" ]
212 f_log
"partially outdated adblock config (${adb_mincfgver} vs. ${adb_cfgver}), please use latest version from '/etc/adblock/adblock.conf.default'"
215 if [ "${apmode_ok}" = "true" ]
217 f_log
"AP mode enabled"
220 # check general package dependencies
227 f_depend
"kmod-ipt-nat"
229 # check ipv6 related package dependencies
231 if [ -n "${adb_wanif6}" ]
233 check
="$(printf "${pkg_list}" | grep "^ip6tables
-")"
236 f_log
"package 'ip6tables' not found, IPv6 support will be disabled"
239 check
="$(printf "${pkg_list}" | grep "^kmod-ipt-nat6
-")"
242 f_log
"package 'kmod-ipt-nat6' not found, IPv6 support will be disabled"
248 # check dns hideout directory
250 if [ -d "${adb_dnshidedir}" ]
252 mv_done
="$(find "${adb_dnshidedir}" -maxdepth 1 -type f -name "${adb_dnsprefix}*" -print -exec mv -f "{}" "${adb_dnsdir}" \;)"
254 mkdir
-p -m 660 "${adb_dnshidedir}"
257 # check ca-certificates package and set fetch parms accordingly
259 fetch_parm
="--no-config --quiet --tries=1 --no-cache --no-cookies --max-redirect=0 --dns-timeout=${adb_fetchttl} --connect-timeout=${adb_fetchttl} --read-timeout=${adb_fetchttl}"
260 check
="$(printf "${pkg_list}" | grep "^ca-certificates
-")"
263 fetch_parm
="${fetch_parm} --no-check-certificate"
266 # check adblock temp directory
268 if [ -n "${adb_tmpdir}" ] && [ -d "${adb_tmpdir}" ]
270 f_space
"${adb_tmpdir}"
271 if [ "${space_ok}" = "false" ]
273 if [ $
((av_space
)) -le 2000 ]
276 f_log
"not enough free space in '${adb_tmpdir}' (avail. ${av_space} kb)" "${rc}"
279 f_log
"not enough free space to handle all adblock list sources at once in '${adb_tmpdir}' (avail. ${av_space} kb)"
284 f_log
"temp directory not found" "${rc}"
290 mem_total
="$(awk '$1 ~ /^MemTotal/ {printf $2}' "/proc
/meminfo
")"
291 mem_free
="$(awk '$1 ~ /^MemFree/ {printf $2}' "/proc
/meminfo
")"
292 mem_swap
="$(awk '$1 ~ /^SwapTotal/ {printf $2}' "/proc
/meminfo
")"
293 if [ $
((mem_total
)) -le 64000 ] && [ $
((mem_swap
)) -eq 0 ]
296 f_log
"not enough free memory, overall sort processing will be disabled (total: ${mem_total}, free: ${mem_free}, swap: ${mem_swap})"
301 # check backup configuration
303 if [ -n "${adb_dir_backup}" ] && [ -d "${adb_dir_backup}" ]
305 f_space
"${adb_dir_backup}"
306 if [ "${space_ok}" = "false" ]
308 f_log
"not enough free space in '${adb_dir_backup}'(avail. ${av_space} kb), backup/restore will be disabled"
311 f_log
"backup/restore will be enabled"
316 f_log
"backup/restore will be disabled"
319 # set dnsmasq defaults
321 if [ -n "${adb_wanif4}" ] && [ -n "${adb_wanif6}" ]
323 adb_dnsformat
="awk -v ipv4="${adb_nullipv4}" -v ipv6="${adb_nullipv6}" '{print \"address=/\"\$0\"/\"ipv4\"\n\"\"address=/\"\$0\"/\"ipv6}'"
324 elif [ -n "${adb_wanif4}" ]
326 adb_dnsformat="awk -v ipv4="${adb_nullipv4}" '{print
\"address
=/\"\
$0\"/\"ipv4
}'"
328 adb_dnsformat="awk -v ipv6="${adb_nullipv6}" '{print
\"address
=/\"\
$0\"/\"ipv6
}'"
331 # check ipv4/iptables configuration
333 if [ -n "${adb_wanif4}" ]
335 f_firewall "IPv4" "nat" "A" "prerouting_rule" "adb-nat" "-p tcp -d ${adb_nullipv4} -m multiport --dports 80,443 -j DNAT --to-destination ${adb_ipv4}:${adb_nullport}"
336 f_firewall "IPv4" "filter" "A" "forwarding_rule" "adb-fwd" "-p tcp -d ${adb_nullipv4} -j REJECT --reject-with tcp-reset"
337 f_firewall "IPv4" "filter" "A" "forwarding_rule" "adb-fwd" "-d ${adb_nullipv4} -j REJECT --reject-with icmp-host-unreachable"
338 f_firewall "IPv4" "filter" "A" "output_rule" "adb-out" "-p tcp -d ${adb_nullipv4} -j REJECT --reject-with tcp-reset"
339 f_firewall "IPv4" "filter" "A" "output_rule" "adb-out" "-d ${adb_nullipv4} -j REJECT --reject-with icmp-host-unreachable"
340 if [ $((adb_forcedns)) -eq 1 ]
342 f_firewall "IPv4" "nat" "A" "prerouting_rule" "adb-dns" "-p udp --dport 53 -j DNAT --to-destination ${adb_ipv4}:53"
343 f_firewall "IPv4" "nat" "A" "prerouting_rule" "adb-dns" "-p tcp --dport 53 -j DNAT --to-destination ${adb_ipv4}:53"
345 if [ "${fw_done}" = "true" ]
347 f_log "created volatile IPv4 firewall ruleset"
352 # check ipv6/ip6tables configuration
354 if [ -n "${adb_wanif6}" ]
356 f_firewall "IPv6" "nat" "A" "PREROUTING" "adb-nat" "-p tcp -d ${adb_nullipv6} -m multiport --dports 80,443 -j DNAT --to-destination [${adb_ipv6}]:${adb_nullport}"
357 f_firewall "IPv6" "filter" "A" "forwarding_rule" "adb-fwd" "-p tcp -d ${adb_nullipv6} -j REJECT --reject-with tcp-reset"
358 f_firewall "IPv6" "filter" "A" "forwarding_rule" "adb-fwd" "-d ${adb_nullipv6} -j REJECT --reject-with icmp6-addr-unreachable"
359 f_firewall "IPv6" "filter" "A" "output_rule" "adb-out" "-p tcp -d ${adb_nullipv6} -j REJECT --reject-with tcp-reset"
360 f_firewall "IPv6" "filter" "A" "output_rule" "adb-out" "-d ${adb_nullipv6} -j REJECT --reject-with icmp6-addr-unreachable"
361 if [ $((adb_forcedns)) -eq 1 ]
363 f_firewall "IPv6" "nat" "A" "PREROUTING" "adb-dns" "-p udp --dport 53 -j DNAT --to-destination [${adb_ipv6}]:53"
364 f_firewall "IPv6" "nat" "A" "PREROUTING" "adb-dns" "-p tcp --dport 53 -j DNAT --to-destination [${adb_ipv6}]:53"
366 if [ "${fw_done}" = "true" ]
368 f_log "created volatile IPv6 firewall ruleset"
373 # check volatile adblock uhttpd instance configuration
375 rc="$(ps | grep -q "[u]httpd.*\-h /www/adblock"; printf ${?})"
378 if [ -n "${adb_wanif4}" ] && [ -n "${adb_wanif6}" ]
380 uhttpd -h "/www/adblock" -k 0 -N 100 -t 0 -T 1 -D -S -E "/index.html" -p "${adb_ipv4}:${adb_nullport}" -p "[${adb_ipv6}]:${adb_nullport}"
382 elif [ -n "${adb_wanif4}" ]
384 uhttpd -h "/www/adblock" -k 0 -N 100 -t 0 -T 1 -D -S -E "/index.html" -p "${adb_ipv4}:${adb_nullport}"
387 uhttpd -h "/www/adblock" -k 0 -N 100 -t 0 -T 1 -D -S -E "/index.html" -p "[${adb_ipv6}]:${adb_nullport}"
392 f_log "created volatile uhttpd instance"
394 f_log "failed to initialize volatile uhttpd instance" "${rc}"
399 # check whitelist entries
401 if [ -s "${adb_whitelist}" ]
403 awk "${adb_whitelist_rset}" "${adb_whitelist}" > "${adb_tmpdir}/tmp.whitelist"
406 # remove no longer used opkg package list
411 # f_depend: check package dependencies
418 check="$(printf "${pkg_list}" | grep "^${package} -")"
422 f_log "package '${package}' not found" "${rc}"
427 # f_firewall: set iptables rules for ipv4/ipv6
431 local ipt="${adb_iptv4}"
439 # select appropriate iptables executable for IPv6
441 if [ "${proto}" = "IPv6" ]
446 # check whether iptables rule already applied and proceed accordingly
448 rc="$("${ipt}" -w -t "${table}" -C "${chain}" -m comment --comment "${notes}" ${rules}; printf ${?})"
451 "${ipt}" -w -t "${table}" -"${ctype}" "${chain}" -m comment --comment "${notes}" ${rules}
457 f_log "failed to initialize volatile ${proto} firewall rule '${notes}'" "${rc}"
463 # f_log: log messages to stdout and syslog
472 # check for terminal session
479 # log to different output devices and set log class accordingly
481 if [ -n "${log_msg}" ]
483 if [ $((log_rc)) -gt 0 ]
486 log_rc=", rc: ${log_rc}"
487 log_msg="${log_msg}${log_rc}"
489 "${adb_log}" ${log_parm} -t "adblock[${adb_pid}] ${class}" "${log_msg}" 2>&1
493 ################################################
494 # f_space: check mount points/space requirements
502 av_space="$(df "${mp}" | tail -n1 | awk '{printf $4}')"
503 if [ $((av_space)) -lt $((adb_minspace)) ]
510 # f_cntconfig: calculate counters in config
518 for src_name in $(ls -ASr "${adb_dnsdir}/${adb_dnsprefix}"*)
520 count="$(wc -l < "${src_name}")"
521 src_name="${src_name##*.}"
522 if [ -n "${adb_wanif4}" ] && [ -n "${adb_wanif6}" ]
526 "${adb_uci}" -q set "adblock.${src_name}.adb_src_count=${count}"
527 count_sum=$((count_sum + count))
529 "${adb_uci}" -q set "adblock.global.adb_overall_count=${count_sum}"
532 # f_rmconfig: remove counters & timestamps in given config sections
538 local restore_done="${2:-false}"
540 for src_name in ${rm_done}
542 src_name="${src_name#*.}"
543 if [ "${restore_done}" = "true" ]
545 src_name="${src_name%.*}"
546 "${adb_uci}" -q set "adblock.${src_name}.adb_src_timestamp=list restored"
548 "${adb_uci}" -q delete "adblock.${src_name}.adb_src_count"
549 "${adb_uci}" -q delete "adblock.${src_name}.adb_src_timestamp"
554 # f_restore: restore last adblock list backups and restart dnsmasq
561 # remove bogus adblock lists
563 if [ -n "${adb_revsrclist}" ]
565 rm_done="$(find "${adb_dnsdir}" -maxdepth 1 -type f \( ${adb_revsrclist} \) -print -exec rm -f "{}" \;)"
567 if [ $((rc)) -eq 0 ] && [ -n "${rm_done}" ]
569 f_rmconfig "${rm_done}"
570 f_log "all bogus adblock lists removed"
571 elif [ $((rc)) -ne 0 ]
573 f_log "error during removal of bogus adblock lists" "${rc}"
580 if [ "${backup_ok}" = "true" ]
582 restore_done="$(find "${adb_dir_backup}" -maxdepth 1 -type f -name "${adb_dnsprefix}*.gz" -print -exec cp -pf "{}" "${adb_dnsdir}" \;)"
584 if [ $((rc)) -eq 0 ] && [ -n "${restore_done}" ]
586 find "${adb_dnsdir}" -maxdepth 1 -type f -name "${adb_dnsprefix}*.gz" -exec gunzip -f "{}" \;
587 f_log "all available backups restored"
588 elif [ $((rc)) -ne 0 ] && [ -n "${restore_done}" ]
590 f_log "error during restore of adblock lists" "${rc}"
594 f_log "backup service disabled, nothing to restore"
597 # (re-)try dnsmasq restart without bogus adblock lists / with backups
599 if [ -n "${restore_done}" ] || [ -n "${rm_done}" ]
601 /etc/init.d/dnsmasq restart
603 rc="$(ps | grep -q "[d]nsmasq"; printf ${?})"
608 f_log "adblock lists with overall ${adb_count} domains loaded"
611 f_log "dnsmasq restart failed, please check 'logread
' output" "${rc}"
617 # f_exit: delete (temporary) files, generate statistics and exit
624 # delete temporary files & directories
626 if [ -f "${adb_tmpfile}" ]
628 rm -f "${adb_tmpfile}"
630 if [ -d "${adb_tmpdir}" ]
632 rm -rf "${adb_tmpdir}"
635 # final log message and iptables statistics
639 if [ -n "${adb_wanif4}" ]
641 ipv4_adblock="$(${adb_iptv4} -t nat -vnL | awk '$11 ~
/^adb-nat$
/ {sum += $1} END
{printf sum}')"
642 ipv4_adblock="$((${ipv4_adblock} + $(${adb_iptv4} -vnL | awk '$11 ~ /^adb-(fwd|out)$/ {sum += $1} END {printf sum}')))"
644 if [ -n "${adb_wanif6}" ]
646 ipv6_adblock="$
(${adb_iptv6} -t nat
-vnL |
awk '$10 ~ /^adb-nat$/ {sum += $1} END {printf sum}')"
647 ipv6_adblock="$
((${ipv6_adblock} + $(${adb_iptv6} -vnL | awk '$10 ~ /^adb-(fwd|out)$/ {sum += $1} END
{printf sum}')))"
649 if [ -n "$(${adb_uci} -q changes adblock)" ]
651 "${adb_uci}" -q commit "adblock"
653 f_log "firewall statistics (IPv4/IPv6): ${ipv4_adblock}/${ipv6_adblock} ad related packets blocked"
654 f_log "domain adblock processing finished successfully (${adb_scriptver}, ${adb_sysver}, $(/bin/date "+%d.%m.%Y %H:%M:%S"))"
655 elif [ $((rc)) -gt 0 ]
657 if [ -n "$(${adb_uci} -q changes adblock)" ]
659 "${adb_uci}" -q revert "adblock"
661 f_log "domain adblock processing failed (${adb_scriptver}, ${adb_sysver}, $(/bin/date "+%d.%m.%Y %H:%M:%S"))"
665 rm -f "${adb_pidfile}"