2 # dns based ad/abuse domain blocking
3 # written by Dirk Brenken (dev@brenken.org)
5 # This is free software, licensed under the GNU General Public License v3.
6 # You should have received a copy of the GNU General Public License
7 # along with this program. If not, see <http://www.gnu.org/licenses/>.
12 PATH="/usr/sbin:/usr/bin:/sbin:/bin"
24 adb_fetch="/usr/bin/wget"
25 adb_fetchparm="--quiet --no-cache --no-cookies --max-redirect=0 --timeout=10 --no-check-certificate -O"
27 adb_dnsprefix="adb_list"
28 adb_dnsfile="${adb_dnsprefix}.overall"
29 adb_whitelist="/etc/adblock/adblock.whitelist"
30 adb_rtfile="/tmp/adb_runtime.json"
31 adb_hashsum="$(command -v sha256sum)"
32 adb_action="${1:-"start"}"
36 # f_envload: load adblock environment
40 local dns_up sys_call sys_desc sys_model sys_ver cnt=0
42 # get system information
44 sys_call="$(ubus -S call system board 2>/dev/null)"
45 if [ -n "${sys_call}" ]
47 sys_desc="$(printf '%s' "${sys_call}" | jsonfilter -e '@.release.description')"
48 sys_model="$(printf '%s' "${sys_call}" | jsonfilter -e '@.model')"
49 sys_ver="$(cat /etc/turris-version 2>/dev/null)"
50 if [ -n "${sys_ver}" ]
52 sys_desc="${sys_desc}/${sys_ver}"
54 adb_sysver="${sys_model}, ${sys_desc}"
57 # source in system libraries
59 if [ -r "/lib/functions.sh" ] && [ -r "/usr/share/libubox/jshn.sh" ]
62 . "/usr/share/libubox/jshn.sh"
64 f_log "error" "system libraries not found"
67 # parse 'global' and 'extra' section by callback
72 if [ "${type}" = "adblock" ]
78 eval "${option}=\"${value}\""
85 # parse 'source' typed sections
89 local value opt section="${1}" options="enabled adb_src adb_src_rset adb_src_cat"
90 eval "adb_sources=\"${adb_sources} ${section}\""
93 config_get value "${section}" "${opt}"
96 eval "${opt}_${section}=\"${value}\""
101 # load adblock config
104 config_foreach parse_config source
106 # set/check dns backend environment
110 adb_dnsuser="${adb_dnsuser:-"dnsmasq"}"
111 adb_dnsdir="${adb_dnsdir:-"/tmp/dnsmasq.d"}"
112 adb_dnsformat="awk '{print \"local=/\"\$0\"/\"}'"
113 if [ ${adb_whitelist_mode} -eq 1 ]
115 adb_dnsformat="awk '{print \"local=/\"\$0\"/#\"}'"
116 adb_dnsblock="local=/#/"
120 adb_dnsuser="${adb_dnsuser:-"unbound"}"
121 adb_dnsdir="${adb_dnsdir:-"/var/lib/unbound"}"
122 adb_dnsformat="awk '{print \"local-zone: \042\"\$0\"\042 static\"}'"
123 if [ ${adb_whitelist_mode} -eq 1 ]
125 adb_dnsformat="awk '{print \"local-zone: \042\"\$0\"\042 transparent\"}'"
126 adb_dnsblock="local-zone: \".\" static"
130 adb_dnsuser="${adb_dnsuser:-"bind"}"
131 adb_dnsdir="${adb_dnsdir:-"/var/lib/bind"}"
132 adb_dnsheader="\$TTL 2h"$'\n'"@ IN SOA localhost. root.localhost. (1 6h 1h 1w 2h)"$'\n'" IN NS localhost."
133 adb_dnsformat="awk '{print \"\"\$0\" CNAME .\n*.\"\$0\" CNAME .\"}'"
134 if [ ${adb_whitelist_mode} -eq 1 ]
136 adb_dnsformat="awk '{print \"\"\$0\" CNAME rpz-passthru.\n*.\"\$0\" CNAME rpz-passthru.\"}'"
137 adb_dnsblock="* CNAME ."
141 adb_dnsuser="${adb_dnsuser:-"root"}"
142 adb_dnsdir="${adb_dnsdir:-"/etc/kresd"}"
143 adb_dnsheader="\$TTL 2h"$'\n'"@ IN SOA localhost. root.localhost. (1 6h 1h 1w 2h)"$'\n'" IN NS localhost."
144 adb_dnsformat="awk '{print \"\"\$0\" CNAME .\n*.\"\$0\" CNAME .\"}'"
145 if [ ${adb_whitelist_mode} -eq 1 ]
147 adb_dnsformat="awk '{print \"\"\$0\" CNAME rpz-passthru.\n*.\"\$0\" CNAME rpz-passthru.\"}'"
148 adb_dnsblock="* CNAME ."
152 adb_dnsuser="${adb_dnsuser:-"nobody"}"
153 adb_dnsdir="${adb_dnsdir:-"/tmp"}"
154 adb_dnsformat="awk '{print \$0}'"
158 # check adblock status
160 if [ ${adb_enabled} -eq 0 ]
162 if [ -s "${adb_dnsdir}/${adb_dnsfile}" ]
169 f_log "info " "adblock is currently disabled, please set adb_enabled to '1' to use this service"
173 if [ -d "${adb_dnsdir}" ] && [ ! -f "${adb_dnsdir}/${adb_dnsfile}" ]
175 > "${adb_dnsdir}/${adb_dnsfile}"
178 case "${adb_action}" in
179 start|restart|reload)
181 if [ "${adb_action}" = "start" ] && [ "${adb_trigger}" = "timed" ]
183 sleep ${adb_triggerdelay}
188 while [ ${cnt} -le 30 ]
190 dns_up="$(ubus -S call service list "{\"name\":\"${adb_dns}\"}" 2>/dev/null | jsonfilter -l1 -e "@[\"${adb_dns}\"].instances.*.running" 2>/dev/null)"
191 if [ "${dns_up}" = "true" ]
199 if [ -z "${adb_dns}" ] || [ -z "${adb_dnsformat}" ] || [ ! -x "$(command -v ${adb_dns})" ] || [ ! -d "${adb_dnsdir}" ]
201 f_log "error" "'${adb_dns}' not running, DNS backend not found"
205 # f_envcheck: check/set environment prerequisites
211 # check external uci config files
215 # check fetch utility
218 if [ -x "${adb_fetch}" ]
220 if [ "$(readlink -fn "${adb_fetch}")" = "/usr/bin/wget-nossl" ]
222 adb_fetchparm="--quiet --no-cache --no-cookies --max-redirect=0 --timeout=10 -O"
223 elif [ "$(readlink -fn "${adb_fetch}")" = "/bin/busybox" ] ||
224 ([ "$(readlink -fn "/bin/wget")" = "/bin/busybox" ] && [ "$(readlink -fn "${adb_fetch}")" != "/usr/bin/wget" ])
226 adb_fetch="/bin/busybox"
227 adb_fetchparm="-q -O"
232 if [ ! -x "${adb_fetch}" ] && [ "$(readlink -fn "/bin/wget")" = "/bin/uclient-fetch" ]
234 adb_fetch="/bin/uclient-fetch"
235 if [ -f "/lib/libustream-ssl.so" ]
237 adb_fetchparm="-q --timeout=10 --no-check-certificate -O"
238 ssl_lib="libustream-ssl"
240 adb_fetchparm="-q --timeout=10 -O"
243 if [ ! -x "${adb_fetch}" ] || [ -z "${adb_fetch}" ] || [ -z "${adb_fetchparm}" ]
245 f_log "error" "no download utility found, please install 'uclient-fetch' with 'libustream-mbedtls' or the full 'wget' package"
247 adb_fetchinfo="${adb_fetch##*/} (${ssl_lib})"
249 # check hashsum utility
251 if [ ! -x "${adb_hashsum}" ]
253 adb_hashsum="$(command -v md5sum)"
256 # initialize temp files and directories
258 adb_tmpload="$(mktemp -tu)"
259 adb_tmpfile="$(mktemp -tu)"
260 adb_tmpdir="$(mktemp -p /tmp -d)"
261 > "${adb_tmpdir}/tmp.whitelist"
264 # f_extconf: set external config options
268 # kresd related options
270 if [ "${adb_dns}" = "kresd" ]
272 if [ ${adb_enabled} -eq 1 ] && [ -z "$(uci -q get resolver.kresd.rpz_file | grep -Fo "${adb_dnsdir}/${adb_dnsfile}")" ]
274 uci -q add_list resolver.kresd.rpz_file="${adb_dnsdir}/${adb_dnsfile}"
275 elif [ ${adb_enabled} -eq 0 ] && [ -n "$(uci -q get resolver.kresd.rpz_file | grep -Fo "${adb_dnsdir}/${adb_dnsfile}")" ]
277 uci -q del_list resolver.kresd.rpz_file="${adb_dnsdir}/${adb_dnsfile}"
279 if [ -n "$(uci -q changes resolver)" ]
281 uci -q commit resolver
285 # firewall related options
287 if [ ${adb_enabled} -eq 1 ] && [ ${adb_forcedns} -eq 1 ] && [ -z "$(uci -q get firewall.adblock_dns)" ]
289 uci -q set firewall.adblock_dns="redirect"
290 uci -q set firewall.adblock_dns.name="Adblock DNS"
291 uci -q set firewall.adblock_dns.src="lan"
292 uci -q set firewall.adblock_dns.proto="tcp udp"
293 uci -q set firewall.adblock_dns.src_dport="53"
294 uci -q set firewall.adblock_dns.dest_port="53"
295 uci -q set firewall.adblock_dns.target="DNAT"
296 elif [ -n "$(uci -q get firewall.adblock_dns)" ] && ([ ${adb_enabled} -eq 0 ] || [ ${adb_forcedns} -eq 0 ])
298 uci -q delete firewall.adblock_dns
300 if [ -n "$(uci -q changes firewall)" ]
302 uci -q commit firewall
303 if [ $(/etc/init.d/firewall enabled; printf "%u" ${?}) -eq 0 ]
305 /etc/init.d/firewall reload >/dev/null 2>&1
310 # f_rmtemp: remove temporary files & directories
314 if [ -d "${adb_tmpdir}" ]
316 rm -f "${adb_tmpload}"
317 rm -f "${adb_tmpfile}"
318 rm -rf "${adb_tmpdir}"
322 # f_rmdns: remove dns related files & directories
326 if [ -n "${adb_dns}" ]
328 > "${adb_dnsdir}/${adb_dnsfile}"
330 rm -f "${adb_dnsdir}/.${adb_dnsfile}"
331 rm -f "${adb_backupdir}/${adb_dnsprefix}"*.gz
335 # f_dnsrestart: restart the dns backend
341 "/etc/init.d/${adb_dns}" restart >/dev/null 2>&1
342 while [ ${cnt} -le 10 ]
344 dns_up="$(ubus -S call service list "{\"name\":\"${adb_dns}\"}" | jsonfilter -l1 -e "@[\"${adb_dns}\"].instances.*.running")"
345 if [ "${dns_up}" = "true" ]
355 # f_list: backup/restore/remove blocklists
359 local mode="${1}" in_rc="${adb_rc}" cnt=0
363 cnt="$(wc -l < "${adb_tmpfile}")"
364 if [ ${adb_backup} -eq 1 ] && [ -d "${adb_backupdir}" ]
366 gzip -cf "${adb_tmpfile}" > "${adb_backupdir}/${adb_dnsprefix}.${src_name}.gz"
371 if [ ${adb_backup} -eq 1 ] && [ -d "${adb_backupdir}" ] &&
372 [ -f "${adb_backupdir}/${adb_dnsprefix}.${src_name}.gz" ]
374 gunzip -cf "${adb_backupdir}/${adb_dnsprefix}.${src_name}.gz" > "${adb_tmpfile}"
379 if [ -d "${adb_backupdir}" ]
381 rm -f "${adb_backupdir}/${adb_dnsprefix}.${src_name}.gz"
386 if [ -s "${adb_tmpfile}" ]
388 cat "${adb_tmpfile}" >> "${adb_tmpdir}/${adb_dnsfile}"
393 if [ -s "${adb_tmpdir}/tmp.whitelist" ]
395 grep -vf "${adb_tmpdir}/tmp.whitelist" "${adb_tmpdir}/${adb_dnsfile}" | eval "${adb_dnsformat}" > "${adb_dnsdir}/${adb_dnsfile}"
397 eval "${adb_dnsformat}" "${adb_tmpdir}/${adb_dnsfile}" > "${adb_dnsdir}/${adb_dnsfile}"
399 if [ -n "${adb_dnsheader}" ]
401 printf '%s\n' "${adb_dnsheader}" | cat - "${adb_dnsdir}/${adb_dnsfile}" > "${adb_tmpdir}/${adb_dnsfile}"
402 cat "${adb_tmpdir}/${adb_dnsfile}" > "${adb_dnsdir}/${adb_dnsfile}"
407 f_log "debug" "name: ${src_name}, mode: ${mode}, count: ${cnt}, in_rc: ${in_rc}, out_rc: ${adb_rc}"
410 # f_tldcompression: top level domain compression
414 local source="${1}" temp="${adb_tmpload}"
416 awk -F "." '{for(f=NF;f > 1;f--) printf "%s.", $f;print $1}' "${source}" 2>/dev/null | sort -u > "${temp}"
417 awk '{if(NR==1){tld=$NF};while(getline){if($NF !~ tld"\\."){print tld;tld=$NF}}print tld}' "${temp}" 2>/dev/null > "${source}"
418 awk -F "." '{for(f=NF;f > 1;f--) printf "%s.", $f;print $1}' "${source}" 2>/dev/null > "${temp}"
419 sort -u "${temp}" > "${source}"
422 # f_switch: suspend/resume adblock processing
426 local source target status mode="${1}"
428 if [ -s "${adb_dnsdir}/${adb_dnsfile}" ] && [ "${mode}" = "suspend" ]
430 source="${adb_dnsdir}/${adb_dnsfile}"
431 target="${adb_dnsdir}/.${adb_dnsfile}"
433 elif [ -s "${adb_dnsdir}/.${adb_dnsfile}" ] && [ "${mode}" = "resume" ]
435 source="${adb_dnsdir}/.${adb_dnsfile}"
436 target="${adb_dnsdir}/${adb_dnsfile}"
439 if [ -n "${status}" ]
441 cat "${source}" > "${target}"
443 chown "${adb_dnsuser}" "${target}" 2>/dev/null
446 f_log "info " "adblock processing ${status}"
450 # f_query: query blocklist for certain (sub-)domains
454 local search result cnt
456 local tld="${domain#*.}"
458 if [ ! -s "${adb_dnsdir}/${adb_dnsfile}" ]
460 printf "%s\n" "::: no active blocklist found, please start / resume adblock first"
461 elif [ -z "${domain}" ] || [ "${domain}" = "${tld}" ]
463 printf "%s\n" "::: invalid domain input, please submit a single domain, e.g. 'doubleclick.net'"
466 while [ "${domain}" != "${tld}" ]
468 search="${domain//./\.}"
469 if [ "${adb_dns}" = "dnsmasq" ] || [ "${adb_dns}" = "unbound" ]
471 result="$(awk -F '/|\"' "/[\/\"\.]${search}/{i++;{printf(\" + %s\n\",\$2)};if(i>9){exit}}" "${adb_dnsfile}")"
473 result="$(awk "/(^[^\*][[:alpha:]]*[\.]+${search}|^${search})/{i++;{printf(\" + %s\n\",\$1)};if(i>9){exit}}" "${adb_dnsfile}")"
475 printf "%s\n" "::: max. ten results for domain '${domain}'"
476 printf "%s\n" "${result:-" - no match"}"
483 # f_jsnupdate: update runtime information
487 local status rundate="$(/bin/date "+%d.%m.%Y %H:%M:%S")"
489 if [ ${adb_rc} -gt 0 ]
492 elif [ ${adb_enabled} -eq 0 ]
495 elif [ -s "${adb_dnsdir}/.${adb_dnsfile}" ]
500 if [ -s "${adb_dnsdir}/${adb_dnsfile}" ]
502 if [ "${adb_dns}" = "named" ] || [ "${adb_dns}" = "kresd" ]
504 adb_cnt="$(( ( $(wc -l < "${adb_dnsdir}/${adb_dnsfile}") - $(printf "%s" "${adb_dnsheader}" | grep -c "^") ) / 2 ))"
506 adb_cnt="$(wc -l < "${adb_dnsdir}/${adb_dnsfile}")"
511 if [ -z "${adb_fetchinfo}" ] && [ -s "${adb_rtfile}" ]
513 json_load "$(cat "${adb_rtfile}" 2>/dev/null)"
515 json_get_var adb_fetchinfo "fetch_utility"
519 json_add_object "data"
520 json_add_string "adblock_status" "${status}"
521 json_add_string "adblock_version" "${adb_ver}"
522 json_add_string "overall_domains" "${adb_cnt}"
523 json_add_string "fetch_utility" "${adb_fetchinfo}"
524 json_add_string "dns_backend" "${adb_dns} (${adb_dnsdir})"
525 json_add_string "last_rundate" "${rundate}"
526 json_add_string "system_release" "${adb_sysver}"
528 json_dump > "${adb_rtfile}"
531 # f_status: output runtime information
535 local key keylist value
537 if [ -s "${adb_rtfile}" ]
539 printf "%s\n" "::: adblock runtime information"
540 json_load "$(cat "${adb_rtfile}" 2>/dev/null)"
542 json_get_keys keylist
543 for key in ${keylist}
545 json_get_var value "${key}"
546 printf " + %-15s : %s\n" "${key}" "${value}"
551 # f_log: write to syslog, exit on error
555 local class="${1}" log_msg="${2}"
557 if [ -n "${log_msg}" ] && ([ "${class}" != "debug" ] || [ ${adb_debug} -eq 1 ])
559 logger -t "adblock-[${adb_ver}] ${class}" "${log_msg}"
560 if [ "${class}" = "error" ]
562 logger -t "adblock-[${adb_ver}] ${class}" "Please check 'https://github.com/openwrt/packages/blob/master/net/adblock/files/README.md' (${adb_sysver})"
564 if [ -s "${adb_dnsdir}/${adb_dnsfile}" ]
576 # main function for blocklist processing
580 local src_name src_rset shalla_archive enabled url hash_old hash_new
581 local mem_total="$(awk '/^MemTotal/ {print int($2/1000)}' "/proc/meminfo")"
583 f_log "info " "start adblock processing ..."
584 f_log "debug" "action: ${adb_action}, dns: ${adb_dns}, fetch: ${adb_fetchinfo}, hashsum: ${adb_hashsum}, backup: ${adb_backup}, backup_mode: ${adb_backup_mode}, whitelist_mode: ${adb_whitelist_mode}, force_srt/_dns: ${adb_forcesrt}/${adb_forcedns}, mem_total: ${mem_total}"
586 > "${adb_dnsdir}/.${adb_dnsfile}"
588 # prepare whitelist entries
590 if [ -s "${adb_whitelist}" ]
592 if [ ${adb_whitelist_mode} -eq 1 ] && [ "${adb_dns}" != "dnscrypt-proxy" ]
594 adb_whitelist_rset="\$0~/^([[:alnum:]_-]+\.){1,}[[:alpha:]]+([[:space:]]|$)/{print tolower(\$1)}"
596 adb_whitelist_rset="\$0~/^([[:alnum:]_-]+\.){1,}[[:alpha:]]+([[:space:]]|$)/{gsub(\"\\\.\",\"\\\.\",\$1);print tolower(\"^\"\$1\"\\\|\\\.\"\$1)}"
598 awk "${adb_whitelist_rset}" "${adb_whitelist}" > "${adb_tmpdir}/tmp.whitelist"
603 if [ ${adb_whitelist_mode} -eq 1 ] && [ "${adb_dns}" != "dnscrypt-proxy" ]
605 f_tldcompression "${adb_tmpdir}/tmp.whitelist"
606 eval "${adb_dnsformat}" "${adb_tmpdir}/tmp.whitelist" > "${adb_dnsdir}/${adb_dnsfile}"
607 printf '%s\n' "${adb_dnsblock}" >> "${adb_dnsdir}/${adb_dnsfile}"
608 if [ -n "${adb_dnsheader}" ]
610 printf '%s\n' "${adb_dnsheader}" | cat - "${adb_dnsdir}/${adb_dnsfile}" > "${adb_tmpdir}/${adb_dnsfile}"
611 cat "${adb_tmpdir}/${adb_dnsfile}" > "${adb_dnsdir}/${adb_dnsfile}"
616 f_jsnupdate "${adb_cnt}"
617 f_log "info " "whitelist with overall ${adb_cnt} domains loaded successfully (${adb_sysver})"
619 f_log "error" "dns backend restart with active whitelist failed"
624 # normal & backup mode
626 for src_name in ${adb_sources}
628 eval "enabled=\"\${enabled_${src_name}}\""
629 eval "url=\"\${adb_src_${src_name}}\""
630 eval "src_rset=\"\${adb_src_rset_${src_name}}\""
637 f_log "debug" "name: ${src_name}, enabled: ${enabled}, url: ${url}, rset: ${src_rset}"
638 if [ "${enabled}" != "1" ] || [ -z "${url}" ] || [ -z "${src_rset}" ]
646 if [ ${adb_backup_mode} -eq 1 ] && [ "${adb_action}" = "start" ] && [ "${src_name}" != "blacklist" ]
649 if [ ${adb_rc} -eq 0 ] && [ -s "${adb_tmpfile}" ]
658 if [ "${src_name}" = "blacklist" ] && [ -s "${url}" ]
660 cat "${url}" > "${adb_tmpload}"
662 elif [ "${src_name}" = "shalla" ]
664 shalla_archive="${adb_tmpdir}/shallalist.tar.gz"
665 "${adb_fetch}" ${adb_fetchparm} "${shalla_archive}" "${url}" 2>/dev/null
667 if [ ${adb_rc} -eq 0 ]
669 for category in ${adb_src_cat_shalla}
671 tar -xOzf "${shalla_archive}" "BL/${category}/domains" >> "${adb_tmpload}"
673 if [ ${adb_rc} -ne 0 ]
679 rm -f "${shalla_archive}"
680 rm -rf "${adb_tmpdir}/BL"
682 "${adb_fetch}" ${adb_fetchparm} "${adb_tmpload}" "${url}" 2>/dev/null
686 # check download result and prepare list output (incl. tld compression, list backup & restore)
688 if [ ${adb_rc} -eq 0 ] && [ -s "${adb_tmpload}" ]
690 awk "${src_rset}" "${adb_tmpload}" 2>/dev/null > "${adb_tmpfile}"
691 if [ -s "${adb_tmpfile}" ]
693 f_tldcompression "${adb_tmpfile}"
694 if [ "${src_name}" != "blacklist" ]
707 if [ ${adb_rc} -eq 0 ] && [ -s "${adb_tmpfile}" ]
710 if [ ${adb_rc} -ne 0 ]
719 # hash preparation, whitelist removal and overall sort
721 if [ -x "${adb_hashsum}" ] && [ -f "${adb_dnsdir}/${adb_dnsfile}" ]
723 hash_old="$(${adb_hashsum} "${adb_dnsdir}/${adb_dnsfile}" 2>/dev/null | awk '{print $1}')"
725 if [ -s "${adb_tmpdir}/${adb_dnsfile}" ]
727 if [ ${mem_total} -ge 64 ] || [ ${adb_forcesrt} -eq 1 ]
729 f_tldcompression "${adb_tmpdir}/${adb_dnsfile}"
733 > "${adb_dnsdir}/${adb_dnsfile}"
735 chown "${adb_dnsuser}" "${adb_dnsdir}/${adb_dnsfile}" 2>/dev/null
738 # conditional restart of the dns backend and runtime information export
740 if [ -x "${adb_hashsum}" ] && [ -f "${adb_dnsdir}/${adb_dnsfile}" ]
742 hash_new="$(${adb_hashsum} "${adb_dnsdir}/${adb_dnsfile}" 2>/dev/null | awk '{print $1}')"
744 if [ -z "${hash_old}" ] || [ -z "${hash_new}" ] || [ "${hash_old}" != "${hash_new}" ]
750 f_jsnupdate "${adb_cnt}"
751 f_log "info " "blocklist with overall ${adb_cnt} domains loaded successfully (${adb_sysver})"
753 f_log "error" "dns backend restart with active blocklist failed"
757 # handle different adblock actions
760 case "${adb_action}" in