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_whitelist
="/etc/adblock/adblock.whitelist"
24 adb_whitelist_rset
="\$1 ~/^([A-Za-z0-9_-]+\.){1,}[A-Za-z]+/{print tolower(\"^\"\$1\"\\\|[.]\"\$1)}"
25 adb_fetch
="/usr/bin/wget"
26 adb_fetchparm
="--quiet --no-cache --no-cookies --max-redirect=0 --timeout=10 --no-check-certificate -O"
27 adb_dnslist
="dnsmasq unbound named"
28 adb_dnsprefix
="adb_list"
29 adb_dnsfile
="${adb_dnsprefix}.overall"
30 adb_rtfile
="/tmp/adb_runtime.json"
35 # f_envload: load adblock environment
39 local services dns_up cnt
=0
41 # source in system libraries
43 if [ -r "/lib/functions.sh" ] && [ -r "/usr/share/libubox/jshn.sh" ]
46 .
"/usr/share/libubox/jshn.sh"
48 f_log
"error" "system libraries not found"
51 # parse global section by callback
56 if [ "${type}" = "adblock" ]
62 eval "${option}=\"${value}\""
69 # parse 'source' sections
73 local value opt section
="${1}" options
="enabled adb_src adb_src_rset adb_src_cat"
74 eval "adb_sources=\"${adb_sources} ${section}\""
77 config_get value
"${section}" "${opt}"
80 eval "${opt}_${section}=\"${value}\""
88 config_foreach parse_config
source
90 # set dns backend environment
92 while [ ${cnt} -le 20 ]
94 services
="$(ubus -S call service list 2>/dev/null)"
95 if [ -n "${services}" ]
97 for dns
in ${adb_dnslist}
99 dns_up
="$(printf "%s
" "${services}" | jsonfilter -l1 -e "@.
${dns}.instances.
*.running
")"
100 if [ "${dns_up}" = "true" ]
105 adb_dnsdir
="${adb_dnsdir:="/tmp/dnsmasq.d"}"
106 adb_dnshidedir
="${adb_dnsdir}/.adb_hidden"
107 adb_dnsformat
="awk '{print \"local=/\"\$0\"/\"}'"
112 adb_dnsdir
="${adb_dnsdir:="/var/lib/unbound"}"
113 adb_dnshidedir
="${adb_dnsdir}/.adb_hidden"
114 adb_dnsformat
="awk '{print \"local-zone: \042\"\$0\"\042 static\"}'"
119 adb_dnsdir
="${adb_dnsdir:="/var/lib/bind"}"
120 adb_dnshidedir
="${adb_dnsdir}/.adb_hidden"
121 adb_dnsformat
="awk '{print \"\"\$0\" IN CNAME .\n*.\"\$0\" IN CNAME .\"}'"
131 if [ -z "${adb_dns}" ] || [ -z "${adb_dnsformat}" ] || [ ! -x "$(command -v ${adb_dns})" ] || [ ! -d "${adb_dnsdir}" ]
133 f_log
"error" "no active/supported DNS backend found"
136 # force dns to local resolver
138 if [ ${adb_forcedns} -eq 1 ] && [ -z "$(uci -q get firewall.adblock_dns)" ]
140 uci
-q set firewall.adblock_dns
="redirect"
141 uci
-q set firewall.adblock_dns.name
="Adblock DNS"
142 uci
-q set firewall.adblock_dns.src
="lan"
143 uci
-q set firewall.adblock_dns.proto
="tcp udp"
144 uci
-q set firewall.adblock_dns.src_dport
="53"
145 uci
-q set firewall.adblock_dns.dest_port
="53"
146 uci
-q set firewall.adblock_dns.target
="DNAT"
147 elif [ ${adb_forcedns} -eq 0 ] && [ -n "$(uci -q get firewall.adblock_dns)" ]
149 uci
-q delete firewall.adblock_dns
151 if [ -n "$(uci -q changes firewall)" ]
153 uci
-q commit firewall
154 if [ $
(/etc
/init.d
/firewall enabled
; printf "%u" ${?}) -eq 0 ]
156 /etc
/init.d
/firewall reload
>/dev
/null
2>&1
161 # f_envcheck: check/set environment prerequisites
167 # check 'enabled' option
169 if [ ${adb_enabled} -ne 1 ]
171 if [ -s "${adb_dnsdir}/${adb_dnsfile}" ]
176 f_log
"info " "adblock is currently disabled, please set adb_enabled to '1' to use this service"
180 # check fetch utility
183 if [ -x "${adb_fetch}" ]
185 if [ "$(readlink -fn "${adb_fetch}")" = "/usr/bin/wget-nossl" ]
187 adb_fetchparm
="--quiet --no-cache --no-cookies --max-redirect=0 --timeout=10 -O"
188 elif [ "$(readlink -fn "/bin
/wget
")" = "/bin/busybox" ] ||
[ "$(readlink -fn "${adb_fetch}")" = "/bin/busybox" ]
190 adb_fetch
="/bin/busybox"
191 adb_fetchparm
="-q -O"
196 if [ ! -x "${adb_fetch}" ] && [ "$(readlink -fn "/bin
/wget
")" = "/bin/uclient-fetch" ]
198 adb_fetch
="/bin/uclient-fetch"
199 if [ -f "/lib/libustream-ssl.so" ]
201 adb_fetchparm
="-q --timeout=10 --no-check-certificate -O"
202 ssl_lib
="libustream-ssl"
204 adb_fetchparm
="-q --timeout=10 -O"
207 if [ ! -x "${adb_fetch}" ] || [ -z "${adb_fetch}" ] || [ -z "${adb_fetchparm}" ]
209 f_log
"error" "no download utility found, please install 'uclient-fetch' with 'libustream-mbedtls' or the full 'wget' package"
211 adb_fetchinfo
="${adb_fetch##*/} (${ssl_lib})"
213 # create dns hideout directory
215 if [ ! -d "${adb_dnshidedir}" ]
217 mkdir
-p -m 660 "${adb_dnshidedir}"
218 chown
-R "${adb_dns}":"${adb_dns}" "${adb_dnshidedir}" 2>/dev
/null
220 rm -f "${adb_dnshidedir}/${adb_dnsprefix}"*
223 # create adblock temp file/directory
225 adb_tmpload
="$(mktemp -tu)"
226 adb_tmpfile
="$(mktemp -tu)"
227 adb_tmpdir
="$(mktemp -p /tmp -d)"
229 # prepare whitelist entries
231 if [ -s "${adb_whitelist}" ]
233 awk "${adb_whitelist_rset}" "${adb_whitelist}" > "${adb_tmpdir}/tmp.whitelist"
237 # f_rmtemp: remove temporary files & directories
241 if [ -d "${adb_tmpdir}" ]
243 rm -f "${adb_tmpload}"
244 rm -f "${adb_tmpfile}"
245 rm -rf "${adb_tmpdir}"
249 # f_rmdns: remove dns related files & directories
253 if [ -n "${adb_dns}" ]
255 rm -f "${adb_dnsdir}/${adb_dnsprefix}"*
256 rm -f "${adb_backupdir}/${adb_dnsprefix}"*.gz
257 rm -rf "${adb_dnshidedir}"
262 # f_dnsrestart: restart the dns backend
266 local dns_up mem_free cnt
=0
268 "/etc/init.d/${adb_dns}" restart
>/dev
/null
2>&1
269 while [ ${cnt} -le 10 ]
271 dns_up
="$(ubus -S call service list "{\"name
\":\"${adb_dns}\"}" | jsonfilter -l1 -e "@.
${adb_dns}.instances.
*.running
")"
272 if [ "${dns_up}" = "true" ]
274 mem_free
="$(awk '/^MemFree/ {print int($2/1000)}' "/proc
/meminfo
")"
275 if [ ${mem_free} -ge ${adb_minfree} ]
286 # f_list: backup/restore/remove block lists
290 local mode
="${1}" in_rc
="${adb_rc}" cnt
=0
294 cnt
="$(wc -l < "${adb_tmpfile}")"
295 if [ ${adb_backup} -eq 1 ] && [ -d "${adb_backupdir}" ]
297 gzip -cf "${adb_tmpfile}" > "${adb_backupdir}/${adb_dnsprefix}.${src_name}.gz"
302 if [ ${adb_backup} -eq 1 ] && [ -d "${adb_backupdir}" ] &&
303 [ -f "${adb_backupdir}/${adb_dnsprefix}.${src_name}.gz" ]
305 gunzip
-cf "${adb_backupdir}/${adb_dnsprefix}.${src_name}.gz" > "${adb_tmpfile}"
310 if [ -d "${adb_backupdir}" ]
312 rm -f "${adb_backupdir}/${adb_dnsprefix}.${src_name}.gz"
317 if [ -s "${adb_tmpdir}/tmp.whitelist" ]
319 grep -vf "${adb_tmpdir}/tmp.whitelist" "${adb_tmpfile}" | eval "${adb_dnsformat}" >> "${adb_tmpdir}/${adb_dnsfile}"
321 eval "${adb_dnsformat}" "${adb_tmpfile}" >> "${adb_tmpdir}/${adb_dnsfile}"
326 f_log
"debug" "name: ${src_name}, mode: ${mode}, count: ${cnt}, in_rc: ${in_rc}, out_rc: ${adb_rc}"
329 # f_switch: suspend/resume adblock processing
333 local source target status mode
="${1}"
335 if [ -d "${adb_dnshidedir}" ]
337 if [ -s "${adb_dnsdir}/${adb_dnsfile}" ] && [ "${mode}" = "suspend" ]
339 source="${adb_dnsdir}/${adb_dnsfile}"
340 target
="${adb_dnshidedir}"
342 elif [ -s "${adb_dnshidedir}/${adb_dnsfile}" ] && [ "${mode}" = "resume" ]
344 source="${adb_dnshidedir}/${adb_dnsfile}"
345 target
="${adb_dnsdir}"
348 if [ -n "${status}" ]
350 mv -f "${source}"* "${target}"
352 f_log
"info " "adblock processing ${status}"
357 # f_query: query block list for certain (sub-)domains
361 local search result cnt
363 local tld
="${domain#*.}"
365 if [ ! -s "${adb_dnsdir}/${adb_dnsfile}" ]
367 printf "%s\n" "::: no active block list found, please start / resume adblock first"
368 elif [ -z "${domain}" ] || [ "${domain}" = "${tld}" ]
370 printf "%s\n" "::: invalid domain input, please submit a specific (sub-)domain, e.g. 'www.abc.xyz'"
373 while [ "${domain}" != "${tld}" ]
375 search
="${domain//./\.}"
376 result
="$(grep -Hm5 "[/\"\.
]${search}[/\"]" "${adb_dnsfile}" | awk -F ':|=|/|\"' '{printf(" + %s\n",$4)}')"
377 printf "%s\n" "::: results for (sub-)domain '${domain}' (max. 5)"
378 printf "%s\n" "${result:=" - no match"}"
385 # f_status: output runtime information
389 local key keylist value
391 if [ -s "${adb_rtfile}" ]
393 if [ -s "${adb_dnsdir}/${adb_dnsfile}" ]
397 value="no domains blocked"
399 printf "%s\n" "::: adblock runtime information"
400 printf " %-15s : %s\n" "status" "${value}"
401 json_load "$(cat "${adb_rtfile}" 2>/dev/null)"
403 json_get_keys keylist
404 for key in ${keylist}
406 json_get_var value "${key}"
407 printf " %-15s : %s\n" "${key}" "${value}"
412 # f_log: write to syslog, exit on error
416 local class="${1}" log_msg="${2}"
418 if [ -n "${log_msg}" ] && ([ "${class}" != "debug" ] || [ ${adb_debug} -eq 1 ])
420 logger -t "adblock-[${adb_ver}] ${class}" "${log_msg}"
421 if [ "${class}" = "error" ]
423 logger -t "adblock-[${adb_ver}] ${class}" "Please check 'https://github.com/openwrt/packages/blob/master/net/adblock/files/README.md' (${adb_sysver})"
425 if [ -s "${adb_dnsdir}/${adb_dnsfile}" ]
435 # main function for block list processing
439 local src_name src_rset shalla_archive enabled url hash_old hash_new cnt=0
440 local mem_total="$(awk '/^MemTotal
/ {print int
($2/1000)}' "/proc/meminfo")"
442 f_log "info " "start adblock processing ..."
443 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}"
445 for src_name in ${adb_sources}
447 eval "enabled=\"\${enabled_${src_name}}\""
448 eval "url=\"\${adb_src_${src_name}}\""
449 eval "src_rset=\"\${adb_src_rset_${src_name}}\""
456 f_log "debug" "name: ${src_name}, enabled: ${enabled}, url: ${url}, rset: ${src_rset}"
457 if [ "${enabled}" != "1" ] || [ -z "${url}" ] || [ -z "${src_rset}" ]
465 if [ ${adb_manmode} -eq 1 ] && [ -z "${adb_action}" ]
468 if [ ${adb_rc} -eq 0 ] && [ -s "${adb_tmpfile}" ]
475 # download block list
477 if [ "${src_name}" = "blacklist" ] && [ -s "${url}" ]
479 cat "${url}" > "${adb_tmpload}"
481 elif [ "${src_name}" = "shalla" ]
483 shalla_archive="${adb_tmpdir}/shallalist.tar.gz"
484 "${adb_fetch}" ${adb_fetchparm} "${shalla_archive}" "${url}" 2>/dev/null
486 if [ ${adb_rc} -eq 0 ]
488 for category in ${adb_src_cat_shalla}
490 tar -xOzf "${shalla_archive}" "BL/${category}/domains" >> "${adb_tmpload}"
492 if [ ${adb_rc} -ne 0 ]
498 rm -f "${shalla_archive}"
499 rm -rf "${adb_tmpdir}/BL"
501 "${adb_fetch}" ${adb_fetchparm} "${adb_tmpload}" "${url}" 2>/dev/null
505 # check download result and prepare domain output (incl. tld compression, list backup & restore)
507 if [ ${adb_rc} -eq 0 ] && [ -s "${adb_tmpload}" ]
509 awk "${src_rset}" "${adb_tmpload}" 2>/dev/null > "${adb_tmpfile}"
510 if [ -s "${adb_tmpfile}" ]
512 awk -F "." '{for(f
=NF
;f
> 1;f--
) printf "%s.", $f;print
$1}' "${adb_tmpfile}" 2>/dev/null | sort -u > "${adb_tmpload}"
513 awk '{if(NR
==1){tld
=$NF};while(getline
){if($NF !~ tld
"\\."){print tld
;tld
=$NF}}print tld
}' "${adb_tmpload}" 2>/dev/null > "${adb_tmpfile}"
514 awk -F "." '{for(f
=NF
;f
> 1;f--
) printf "%s.", $f;print
$1}' "${adb_tmpfile}" 2>/dev/null > "${adb_tmpload}"
515 mv -f "${adb_tmpload}" "${adb_tmpfile}"
524 # remove whitelist domains, final list preparation
526 if [ ${adb_rc} -eq 0 ] && [ -s "${adb_tmpfile}" ]
529 if [ ${adb_rc} -ne 0 ]
538 # hash preparation & overall sort
540 if [ -f "${adb_dnsdir}/${adb_dnsfile}" ]
542 hash_old="$(sha256sum "${adb_dnsdir}/${adb_dnsfile}" | awk '{print $1}')"
544 if [ -s "${adb_tmpdir}/${adb_dnsfile}" ]
546 if [ ${mem_total} -ge 64 ] || [ ${adb_forcesrt} -eq 1 ]
548 sort -u "${adb_tmpdir}/${adb_dnsfile}" > "${adb_dnsdir}/${adb_dnsfile}"
550 mv -f "${adb_tmpdir}/${adb_dnsfile}" "${adb_dnsdir}" 2>/dev/null
553 > "${adb_dnsdir}/${adb_dnsfile}"
555 hash_new="$
(sha256sum
"${adb_dnsdir}/${adb_dnsfile}" | awk '{print $1}')"
556 cnt
="$(wc -l < "${adb_dnsdir}/${adb_dnsfile}")"
558 # conditional restart of the dns backend and runtime information export
560 chown
"${adb_dns}":"${adb_dns}" "${adb_dnsdir}/${adb_dnsfile}" 2>/dev
/null
562 if [ "${hash_old}" != "${hash_new}" ]
569 json_add_object
"data"
570 json_add_string
"adblock_version" "${adb_ver}"
571 json_add_string
"blocked_domains" "${cnt}"
572 json_add_string
"fetch_info" "${adb_fetchinfo}"
573 json_add_string
"dns_backend" "${adb_dns}"
574 json_add_string
"last_rundate" "$(/bin/date "+%d.
%m.
%Y
%H
:%M
:%S
")"
575 json_add_string
"system" "${adb_sysver}"
577 json_dump
> "${adb_rtfile}"
578 f_log
"info " "block list with overall ${cnt} domains loaded successfully (${adb_sysver})"
580 f_log
"error" "dns backend restart with active block list failed"
584 # handle different adblock actions
587 case "${adb_action}" in