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"
14 adb_sysver
="$(ubus -S call system board | jsonfilter -e '@.release.description')"
23 adb_fetch
="/usr/bin/wget"
24 adb_fetchparm
="--quiet --no-cache --no-cookies --max-redirect=0 --timeout=10 --no-check-certificate -O"
26 adb_dnsprefix
="adb_list"
27 adb_dnsfile
="${adb_dnsprefix}.overall"
28 adb_rtfile
="/tmp/adb_runtime.json"
29 adb_action
="${1:-"start"}"
33 # f_envload: load adblock environment
39 # source in system libraries
41 if [ -r "/lib/functions.sh" ] && [ -r "/usr/share/libubox/jshn.sh" ]
44 .
"/usr/share/libubox/jshn.sh"
46 f_log
"error" "system libraries not found"
49 # parse global section by callback
54 if [ "${type}" = "adblock" ]
60 eval "${option}=\"${value}\""
67 # parse 'source' sections
71 local value opt section
="${1}" options
="enabled adb_src adb_src_rset adb_src_cat"
72 eval "adb_sources=\"${adb_sources} ${section}\""
75 config_get value
"${section}" "${opt}"
78 eval "${opt}_${section}=\"${value}\""
86 config_foreach parse_config
source
88 # set dns backend environment
90 case "${adb_action}" in
93 if [ "${adb_action}" = "start" ] && [ "${adb_trigger}" = "timed" ]
95 sleep ${adb_triggerdelay}
99 while [ ${cnt} -le 30 ]
101 dns_up
="$(ubus -S call service list "{\"name
\":\"${adb_dns}\"}" 2>/dev/null | jsonfilter -l1 -e "@
[\"${adb_dns}\"].instances.
*.running
" 2>/dev/null)"
102 if [ "${dns_up}" = "true" ]
106 adb_dnsuser
="${adb_dns}"
107 adb_dnsdir
="${adb_dnsdir:-"/tmp/dnsmasq.d"}"
108 adb_dnsformat
="awk '{print \"local=/\"\$0\"/\"}'"
112 adb_dnsuser
="${adb_dns}"
113 adb_dnsdir
="${adb_dnsdir:-"/var/lib/unbound"}"
114 adb_dnsformat
="awk '{print \"local-zone: \042\"\$0\"\042 static\"}'"
119 adb_dnsdir
="${adb_dnsdir:-"/var/lib/bind"}"
120 adb_dnsformat
="awk '{print \"\"\$0\" IN CNAME .\n*.\"\$0\" IN CNAME .\"}'"
125 adb_dnsdir
="${adb_dnsdir:-"/etc/kresd"}"
126 adb_dnsformat
="awk '{print \"\"\$0\" CNAME .\n*.\"\$0\" CNAME .\"}'"
127 adb_dnsheader
="\$TTL 2h"$
'\n'"@ IN SOA localhost. root.localhost. (2 6h 1h 1w 2h)"$
'\n'" IN NS localhost."
132 adb_dnsdir
="${adb_dnsdir:-"/tmp"}"
133 adb_dnsformat
="awk '{print \$0}'"
141 if [ -z "${adb_dns}" ] || [ -z "${adb_dnsformat}" ] || [ ! -x "$(command -v ${adb_dns})" ] || [ ! -d "${adb_dnsdir}" ]
143 f_log
"error" "'${adb_dns}' not running, DNS backend not found"
146 # force dns to local resolver
148 if [ ${adb_forcedns} -eq 1 ] && [ -z "$(uci -q get firewall.adblock_dns)" ]
150 uci
-q set firewall.adblock_dns
="redirect"
151 uci
-q set firewall.adblock_dns.name
="Adblock DNS"
152 uci
-q set firewall.adblock_dns.src
="lan"
153 uci
-q set firewall.adblock_dns.proto
="tcp udp"
154 uci
-q set firewall.adblock_dns.src_dport
="53"
155 uci
-q set firewall.adblock_dns.dest_port
="53"
156 uci
-q set firewall.adblock_dns.target
="DNAT"
157 elif [ ${adb_forcedns} -eq 0 ] && [ -n "$(uci -q get firewall.adblock_dns)" ]
159 uci
-q delete firewall.adblock_dns
161 if [ -n "$(uci -q changes firewall)" ]
163 uci
-q commit firewall
164 if [ $
(/etc
/init.d
/firewall enabled
; printf "%u" ${?}) -eq 0 ]
166 /etc
/init.d
/firewall reload
>/dev
/null
2>&1
171 # f_envcheck: check/set environment prerequisites
177 # check 'enabled' option
179 if [ ${adb_enabled} -ne 1 ]
181 if [ -s "${adb_dnsdir}/${adb_dnsfile}" ]
187 f_log
"info " "adblock is currently disabled, please set adb_enabled to '1' to use this service"
191 # check fetch utility
194 if [ -x "${adb_fetch}" ]
196 if [ "$(readlink -fn "${adb_fetch}")" = "/usr/bin/wget-nossl" ]
198 adb_fetchparm
="--quiet --no-cache --no-cookies --max-redirect=0 --timeout=10 -O"
199 elif [ "$(readlink -fn "${adb_fetch}")" = "/bin/busybox" ] ||
200 ([ "$(readlink -fn "/bin
/wget
")" = "/bin/busybox" ] && [ "$(readlink -fn "${adb_fetch}")" != "/usr/bin/wget" ])
202 adb_fetch
="/bin/busybox"
203 adb_fetchparm
="-q -O"
208 if [ ! -x "${adb_fetch}" ] && [ "$(readlink -fn "/bin
/wget
")" = "/bin/uclient-fetch" ]
210 adb_fetch
="/bin/uclient-fetch"
211 if [ -f "/lib/libustream-ssl.so" ]
213 adb_fetchparm
="-q --timeout=10 --no-check-certificate -O"
214 ssl_lib
="libustream-ssl"
216 adb_fetchparm
="-q --timeout=10 -O"
219 if [ ! -x "${adb_fetch}" ] || [ -z "${adb_fetch}" ] || [ -z "${adb_fetchparm}" ]
221 f_log
"error" "no download utility found, please install 'uclient-fetch' with 'libustream-mbedtls' or the full 'wget' package"
223 adb_fetchinfo
="${adb_fetch##*/} (${ssl_lib})"
225 # create adblock temp file/directory
227 adb_tmpload
="$(mktemp -tu)"
228 adb_tmpfile
="$(mktemp -tu)"
229 adb_tmpdir
="$(mktemp -p /tmp -d)"
231 # prepare whitelist entries
233 if [ -s "${adb_whitelist}" ] && [ -n "${adb_whitelist_rset}" ]
235 awk "${adb_whitelist_rset}" "${adb_whitelist}" > "${adb_tmpdir}/tmp.whitelist"
239 # f_rmtemp: remove temporary files & directories
243 if [ -d "${adb_tmpdir}" ]
245 rm -f "${adb_tmpload}"
246 rm -f "${adb_tmpfile}"
247 rm -rf "${adb_tmpdir}"
251 # f_rmdns: remove dns related files & directories
255 if [ -n "${adb_dns}" ]
257 > "${adb_dnsdir}/${adb_dnsfile}"
259 rm -f "${adb_dnsdir}/.${adb_dnsfile}"
260 rm -f "${adb_backupdir}/${adb_dnsprefix}"*.gz
264 # f_dnsrestart: restart the dns backend
270 "/etc/init.d/${adb_dns}" restart
>/dev
/null
2>&1
271 while [ ${cnt} -le 10 ]
273 dns_up
="$(ubus -S call service list "{\"name
\":\"${adb_dns}\"}" | jsonfilter -l1 -e "@
[\"${adb_dns}\"].instances.
*.running
")"
274 if [ "${dns_up}" = "true" ]
284 # f_list: backup/restore/remove block lists
288 local mode
="${1}" in_rc
="${adb_rc}" cnt
=0
292 cnt
="$(wc -l < "${adb_tmpfile}")"
293 if [ ${adb_backup} -eq 1 ] && [ -d "${adb_backupdir}" ]
295 gzip -cf "${adb_tmpfile}" > "${adb_backupdir}/${adb_dnsprefix}.${src_name}.gz"
300 if [ ${adb_backup} -eq 1 ] && [ -d "${adb_backupdir}" ] &&
301 [ -f "${adb_backupdir}/${adb_dnsprefix}.${src_name}.gz" ]
303 gunzip
-cf "${adb_backupdir}/${adb_dnsprefix}.${src_name}.gz" > "${adb_tmpfile}"
308 if [ -d "${adb_backupdir}" ]
310 rm -f "${adb_backupdir}/${adb_dnsprefix}.${src_name}.gz"
315 if [ -s "${adb_tmpfile}" ]
317 cat "${adb_tmpfile}" >> "${adb_tmpdir}/${adb_dnsfile}"
322 if [ -s "${adb_tmpdir}/tmp.whitelist" ]
324 grep -vf "${adb_tmpdir}/tmp.whitelist" "${adb_tmpdir}/${adb_dnsfile}" | eval "${adb_dnsformat}" > "${adb_dnsdir}/${adb_dnsfile}"
326 eval "${adb_dnsformat}" "${adb_tmpdir}/${adb_dnsfile}" > "${adb_dnsdir}/${adb_dnsfile}"
328 if [ -n "${adb_dnsheader}" ]
330 printf '%s\n' "${adb_dnsheader}" | cat - "${adb_dnsdir}/${adb_dnsfile}" > "${adb_tmpdir}/${adb_dnsfile}"
331 cat "${adb_tmpdir}/${adb_dnsfile}" > "${adb_dnsdir}/${adb_dnsfile}"
336 f_log
"debug" "name: ${src_name}, mode: ${mode}, count: ${cnt}, in_rc: ${in_rc}, out_rc: ${adb_rc}"
339 # f_tldcompression: top level domain compression
343 local source="${1}" temp
="${adb_tmpload}"
345 awk -F "." '{for(f=NF;f > 1;f--) printf "%s.", $f;print $1}' "${source}" 2>/dev
/null |
sort -u > "${temp}"
346 awk '{if(NR==1){tld=$NF};while(getline){if($NF !~ tld"\\."){print tld;tld=$NF}}print tld}' "${temp}" 2>/dev
/null
> "${source}"
347 awk -F "." '{for(f=NF;f > 1;f--) printf "%s.", $f;print $1}' "${source}" 2>/dev
/null
> "${temp}"
348 sort -u "${temp}" > "${source}"
351 # f_switch: suspend/resume adblock processing
355 local source target status mode
="${1}"
357 if [ -s "${adb_dnsdir}/${adb_dnsfile}" ] && [ "${mode}" = "suspend" ]
359 source="${adb_dnsdir}/${adb_dnsfile}"
360 target
="${adb_dnsdir}/.${adb_dnsfile}"
362 elif [ -s "${adb_dnsdir}/.${adb_dnsfile}" ] && [ "${mode}" = "resume" ]
364 source="${adb_dnsdir}/.${adb_dnsfile}"
365 target
="${adb_dnsdir}/${adb_dnsfile}"
368 if [ -n "${status}" ]
370 cat "${source}" > "${target}"
374 f_log
"info " "adblock processing ${status}"
378 # f_query: query block list for certain (sub-)domains
382 local search result cnt
384 local tld
="${domain#*.}"
386 if [ ! -s "${adb_dnsdir}/${adb_dnsfile}" ]
388 printf "%s\n" "::: no active block list found, please start / resume adblock first"
389 elif [ -z "${domain}" ] || [ "${domain}" = "${tld}" ]
391 printf "%s\n" "::: invalid domain input, please submit a single domain, e.g. 'doubleclick.net'"
394 while [ "${domain}" != "${tld}" ]
396 search
="${domain//./\.}"
397 if [ "${adb_dns}" = "dnsmasq" ] ||
[ "${adb_dns}" = "unbound" ]
399 result
="$(awk -F '/|\"' "/[\
/\"\.
]${search}/{i
++;{printf(\" + %s
\n\",\
$2)};if(i
>9){exit}}" "${adb_dnsfile}")"
401 result
="$(awk "/(^
[^\
*][a-z
]*[\.
]+${search}|^${search})/{i++;{printf(\" + %s\n\",\$1)};if(i
>9){exit}}" "${adb_dnsfile}")"
403 printf "%s\n" "::: max. ten results for domain '${domain}'"
404 printf "%s\n" "${result:-" - no match"}"
411 # f_jsnupdate: update runtime information
415 local status rundate
="$(/bin/date "+%d.
%m.
%Y
%H
:%M
:%S
")"
417 if [ ${adb_rc} -gt 0 ]
420 elif [ ${adb_enabled} -ne 1 ]
423 elif [ -s "${adb_dnsdir}/.${adb_dnsfile}" ]
428 if [ -s "${adb_dnsdir}/${adb_dnsfile}" ]
430 if [ "${adb_dns}" = "named" ] ||
[ "${adb_dns}" = "kresd" ]
432 adb_cnt
="$(( ( $(wc -l < "${adb_dnsdir}/${adb_dnsfile}") - $(printf "%s" "${adb_dnsheader}" | grep -c "^
") ) / 2 ))"
434 adb_cnt
="$(( $(wc -l < "${adb_dnsdir}/${adb_dnsfile}") - $(printf "%s" "${adb_dnsheader}" | grep -c "^
") ))"
439 if [ -z "${adb_fetchinfo}" ] && [ -s "${adb_rtfile}" ]
441 json_load
"$(cat "${adb_rtfile}" 2>/dev/null)"
443 json_get_var adb_fetchinfo
"fetch_utility"
447 json_add_object
"data"
448 json_add_string
"adblock_status" "${status}"
449 json_add_string
"adblock_version" "${adb_ver}"
450 json_add_string
"blocked_domains" "${adb_cnt}"
451 json_add_string
"fetch_utility" "${adb_fetchinfo}"
452 json_add_string
"dns_backend" "${adb_dns} (${adb_dnsdir})"
453 json_add_string
"last_rundate" "${rundate}"
454 json_add_string
"system_release" "${adb_sysver}"
456 json_dump
> "${adb_rtfile}"
459 # f_status: output runtime information
463 local key keylist value
465 if [ -s "${adb_rtfile}" ]
467 printf "%s\n" "::: adblock runtime information"
468 json_load
"$(cat "${adb_rtfile}" 2>/dev/null)"
470 json_get_keys keylist
471 for key
in ${keylist}
473 json_get_var value
"${key}"
474 printf " + %-15s : %s\n" "${key}" "${value}"
479 # f_log: write to syslog, exit on error
483 local class
="${1}" log_msg
="${2}"
485 if [ -n "${log_msg}" ] && ([ "${class}" != "debug" ] || [ ${adb_debug} -eq 1 ])
487 logger -t "adblock-
[${adb_ver}] ${class}" "${log_msg}"
488 if [ "${class}" = "error
" ]
490 logger -t "adblock-
[${adb_ver}] ${class}" "Please check 'https://github.com/openwrt/packages/blob/master/net/adblock/files/README.md' (${adb_sysver})"
492 if [ -s "${adb_dnsdir}/${adb_dnsfile}" ]
504 # main function for block list processing
508 local src_name src_rset shalla_archive enabled url hash_old hash_new
509 local mem_total="$
(awk '/^MemTotal/ {print int($2/1000)}' "/proc/meminfo")"
511 f_log "info
" "start adblock processing ...
"
512 f_log "debug
" "action
: ${adb_action}, manual_mode:${adb_manmode}, backup: ${adb_backup}, dns: ${adb_dns}, fetch: ${adb_fetchinfo}, mem_total: ${mem_total}, force_srt/_dns: ${adb_forcesrt}/${adb_forcedns}"
514 for src_name in ${adb_sources}
516 eval "enabled
=\"\
${enabled_${src_name}}\""
517 eval "url
=\"\
${adb_src_${src_name}}\""
518 eval "src_rset
=\"\
${adb_src_rset_${src_name}}\""
525 f_log "debug
" "name
: ${src_name}, enabled: ${enabled}, url: ${url}, rset: ${src_rset}"
526 if [ "${enabled}" != "1" ] || [ -z "${url}" ] || [ -z "${src_rset}" ]
532 # manual / backup mode
534 if [ ${adb_manmode} -eq 1 ] && [ "${adb_action}" = "start" ] && [ "${src_name}" != "blacklist" ]
537 if [ ${adb_rc} -eq 0 ] && [ -s "${adb_tmpfile}" ]
544 # download block list
546 if [ "${src_name}" = "blacklist" ] && [ -s "${url}" ]
548 cat "${url}" > "${adb_tmpload}"
550 elif [ "${src_name}" = "shalla" ]
552 shalla_archive
="${adb_tmpdir}/shallalist.tar.gz"
553 "${adb_fetch}" ${adb_fetchparm} "${shalla_archive}" "${url}" 2>/dev
/null
555 if [ ${adb_rc} -eq 0 ]
557 for category
in ${adb_src_cat_shalla}
559 tar -xOzf "${shalla_archive}" "BL/${category}/domains" >> "${adb_tmpload}"
561 if [ ${adb_rc} -ne 0 ]
567 rm -f "${shalla_archive}"
568 rm -rf "${adb_tmpdir}/BL"
570 "${adb_fetch}" ${adb_fetchparm} "${adb_tmpload}" "${url}" 2>/dev
/null
574 # check download result and prepare list output (incl. tld compression, list backup & restore)
576 if [ ${adb_rc} -eq 0 ] && [ -s "${adb_tmpload}" ]
578 awk "${src_rset}" "${adb_tmpload}" 2>/dev/null > "${adb_tmpfile}"
579 if [ -s "${adb_tmpfile}" ]
581 f_tldcompression
"${adb_tmpfile}"
582 if [ "${src_name}" != "blacklist" ]
595 if [ ${adb_rc} -eq 0 ] && [ -s "${adb_tmpfile}" ]
598 if [ ${adb_rc} -ne 0 ]
607 # hash preparation, whitelist removal and overall sort
609 if [ -f "${adb_dnsdir}/${adb_dnsfile}" ]
611 hash_old
="$(sha256sum "${adb_dnsdir}/${adb_dnsfile}" 2>/dev/null | awk '{print $1}')"
613 if [ -s "${adb_tmpdir}/${adb_dnsfile}" ]
615 if [ ${mem_total} -ge 64 ] || [ ${adb_forcesrt} -eq 1 ]
617 f_tldcompression "${adb_tmpdir}/${adb_dnsfile}"
621 > "${adb_dnsdir}/${adb_dnsfile}"
623 chown "${adb_dnsuser}":"${adb_dnsuser}" "${adb_dnsdir}/${adb_dnsfile}" 2>/dev/null
626 # conditional restart of the dns backend and runtime information export
628 hash_new="$(sha256sum "${adb_dnsdir}/${adb_dnsfile}" 2>/dev/null | awk '{print $1}')"
629 if [ -z "${hash_old}" ] || [ -z "${hash_new}" ] || [ "${hash_old}" != "${hash_new}" ]
635 f_jsnupdate "${adb_cnt}"
636 f_log "info
" "block list with overall
${adb_cnt} domains loaded successfully
(${adb_sysver})"
638 f_log "error
" "dns backend restart with active block list failed
"
642 # handle different adblock actions
645 case "${adb_action}" in