mirror of
https://github.com/openwrt/packages.git
synced 2026-04-15 10:51:55 +00:00
* fixed a problem/regression with the display of results in f_search and f_report Signed-off-by: Dirk Brenken <dev@brenken.org>
2298 lines
74 KiB
Bash
Executable File
2298 lines
74 KiB
Bash
Executable File
#!/bin/sh
|
||
# dns based ad/abuse domain blocking
|
||
# Copyright (c) 2015-2026 Dirk Brenken (dev@brenken.org)
|
||
# This is free software, licensed under the GNU General Public License v3.
|
||
|
||
# (s)hellcheck exceptions
|
||
# shellcheck disable=all
|
||
|
||
# set initial defaults
|
||
#
|
||
export LC_ALL=C
|
||
export PATH="/usr/sbin:/usr/bin:/sbin:/bin"
|
||
|
||
adb_enabled="0"
|
||
adb_debug="0"
|
||
adb_nftforce="0"
|
||
adb_nftdevforce=""
|
||
adb_nftportforce=""
|
||
adb_nftallow="0"
|
||
adb_nftmacallow=""
|
||
adb_nftdevallow=""
|
||
adb_nftblock="0"
|
||
adb_nftmacblock=""
|
||
adb_nftdevblock=""
|
||
adb_nftremote="0"
|
||
adb_nftremotetimeout="15"
|
||
adb_nftmacremote=""
|
||
adb_nftbridge="0"
|
||
adb_allowdnsv4=""
|
||
adb_allowdnsv6=""
|
||
adb_remotednsv4=""
|
||
adb_remotednsv6=""
|
||
adb_blockdnsv4=""
|
||
adb_blockdnsv6=""
|
||
adb_bridgednsv4=""
|
||
adb_bridgednsv6=""
|
||
adb_dnsshift="0"
|
||
adb_dnsflush="0"
|
||
adb_dnstimeout="20"
|
||
adb_safesearch="0"
|
||
adb_report="0"
|
||
adb_trigger=""
|
||
adb_triggerdelay="5"
|
||
adb_mail="0"
|
||
adb_jail="0"
|
||
adb_map="0"
|
||
adb_tld="1"
|
||
adb_dns=""
|
||
adb_dnspid=""
|
||
adb_locallist="allowlist blocklist"
|
||
adb_basedir="/tmp"
|
||
adb_finaldir=""
|
||
adb_backupdir="/tmp/adblock-backup"
|
||
adb_reportdir="/tmp/adblock-report"
|
||
adb_pidfile="/var/run/adblock.pid"
|
||
adb_allowlist="/etc/adblock/adblock.allowlist"
|
||
adb_blocklist="/etc/adblock/adblock.blocklist"
|
||
adb_mailservice="/etc/adblock/adblock.mail"
|
||
adb_dnsfile="adb_list.overall"
|
||
adb_feedfile="/etc/adblock/adblock.feeds"
|
||
adb_customfeedfile="/etc/adblock/adblock.custom.feeds"
|
||
adb_rtfile="/var/run/adb_runtime.json"
|
||
adb_errorlog="/dev/null"
|
||
adb_fetchcmd=""
|
||
adb_fetchinsecure=""
|
||
adb_fetchparm=""
|
||
adb_etagparm=""
|
||
adb_geoparm=""
|
||
adb_geourl="http://ip-api.com/json"
|
||
adb_repiface=""
|
||
adb_repport="53"
|
||
adb_repchunkcnt="5"
|
||
adb_repchunksize="1"
|
||
adb_represolve="0"
|
||
adb_lookupdomain="localhost"
|
||
adb_action="${1}"
|
||
adb_packages=""
|
||
adb_cnt=""
|
||
|
||
# command selector
|
||
#
|
||
f_cmd() {
|
||
local cmd pri_cmd="${1}" sec_cmd="${2}"
|
||
|
||
cmd="$(command -v "${pri_cmd}" 2>/dev/null)"
|
||
if [ ! -x "${cmd}" ]; then
|
||
if [ -n "${sec_cmd}" ]; then
|
||
[ "${sec_cmd}" = "optional" ] && return
|
||
cmd="$(command -v "${sec_cmd}" 2>/dev/null)"
|
||
fi
|
||
if [ -x "${cmd}" ]; then
|
||
printf '%s' "${cmd}"
|
||
else
|
||
f_log "emerg" "command '${pri_cmd:-"-"}'/'${sec_cmd:-"-"}' not found"
|
||
fi
|
||
else
|
||
printf '%s' "${cmd}"
|
||
fi
|
||
}
|
||
|
||
# load adblock environment
|
||
#
|
||
f_load() {
|
||
local bg_pid port filter tcpdump_filter cpu core
|
||
|
||
# load adblock config and set debug log file
|
||
#
|
||
f_conf
|
||
if [ "${adb_debug}" = "1" ] && [ -d "${adb_basedir}" ]; then
|
||
adb_errorlog="${adb_basedir}/adb_error.log"
|
||
else
|
||
adb_errorlog="/dev/null"
|
||
fi
|
||
|
||
# fetch installed packages amd system information
|
||
#
|
||
adb_packages="$("${adb_ubuscmd}" -S call rpc-sys packagelist '{ "all": true }' 2>>"${adb_errorlog}")"
|
||
adb_bver="$(printf '%s' "${adb_packages}" | "${adb_jsoncmd}" -ql1 -e '@.packages.adblock')"
|
||
adb_fver="$(printf '%s' "${adb_packages}" | "${adb_jsoncmd}" -ql1 -e '@.packages["luci-app-adblock"]')"
|
||
adb_sysver="$("${adb_ubuscmd}" -S call system board 2>>"${adb_errorlog}" | \
|
||
"${adb_jsoncmd}" -ql1 -e '@.model' -e '@.release.target' -e '@.release.distribution' -e '@.release.version' -e '@.release.revision' | \
|
||
"${adb_awkcmd}" 'BEGIN{RS="";FS="\n"}{printf "%s, %s, %s %s (%s)",$1,$2,$3,$4,$5}')"
|
||
|
||
# detect cpu cores for parallel processing
|
||
#
|
||
if [ -z "${adb_cores}" ]; then
|
||
cpu="$("${adb_grepcmd}" -c '^processor' /proc/cpuinfo 2>>"${adb_errorlog}")"
|
||
core="$("${adb_grepcmd}" -cm1 '^core id' /proc/cpuinfo 2>>"${adb_errorlog}")"
|
||
[ "${cpu}" = "0" ] && cpu="1"
|
||
[ "${core}" = "0" ] && core="1"
|
||
adb_cores="$((cpu * core))"
|
||
[ "${adb_cores}" -gt "16" ] && adb_cores="16"
|
||
fi
|
||
|
||
# load dns backend and fetch utility
|
||
#
|
||
if [ "${adb_action}" != "report" ] && [ "${adb_action}" != "mail" ]; then
|
||
f_dns
|
||
f_fetch
|
||
fi
|
||
|
||
# check if reporting is enabled and tcpdump is available
|
||
#
|
||
if [ "${adb_report}" = "1" ] && [ ! -x "${adb_dumpcmd}" ]; then
|
||
f_log "info" "please install the package 'tcpdump' or 'tcpdump-mini' to use the reporting feature"
|
||
elif [ -x "${adb_dumpcmd}" ]; then
|
||
bg_pid="$("${adb_pgrepcmd}" -nf "${adb_reportdir}/adb_report.pcap")"
|
||
if [ -n "${bg_pid}" ] && { [ "${adb_report}" = "0" ] || [ "${adb_action}" = "stop" ] || [ "${adb_action}" = "restart" ]; }; then
|
||
if kill -HUP "${bg_pid}" 2>>"${adb_errorlog}"; then
|
||
for cnt in 1 2 3; do
|
||
kill -0 "${bg_pid}" >/dev/null 2>&1 || break
|
||
sleep 1
|
||
done
|
||
fi
|
||
bg_pid="$("${adb_pgrepcmd}" -nf "${adb_reportdir}/adb_report.pcap")"
|
||
"${adb_rmcmd}" -f "${adb_reportdir}"/adb_report.pcap*
|
||
fi
|
||
|
||
if [ "${adb_report}" = "1" ] && [ -z "${bg_pid}" ] && [ "${adb_action}" != "report" ] && [ "${adb_action}" != "stop" ]; then
|
||
[ ! -d "${adb_reportdir}" ] && mkdir -p "${adb_reportdir}"
|
||
if [ -z "${adb_repiface}" ]; then
|
||
network_get_device adb_repiface "lan"
|
||
[ -z "${adb_repiface}" ] && network_get_physdev adb_repiface "lan"
|
||
uci_set adblock global adb_repiface "${adb_repiface:-"any"}"
|
||
f_uci "adblock"
|
||
fi
|
||
for port in ${adb_repport}; do
|
||
[ -n "${filter}" ] && filter="${filter} or "
|
||
filter="${filter}(udp port ${port}) or (tcp port ${port})"
|
||
done
|
||
tcpdump_filter="(${filter}) and greater 28"
|
||
if [ -n "${adb_repiface}" ] && [ -d "${adb_reportdir}" ]; then
|
||
(
|
||
"${adb_dumpcmd}" --immediate-mode -nn -p -s0 -i "${adb_repiface}" \
|
||
"${tcpdump_filter}" \
|
||
-C "${adb_repchunksize}" -W "${adb_repchunkcnt}" \
|
||
-w "${adb_reportdir}/adb_report.pcap" >/dev/null 2>&1 &
|
||
)
|
||
sleep 1
|
||
bg_pid="$("${adb_pgrepcmd}" -nf "${adb_reportdir}/adb_report.pcap")"
|
||
f_log "info" "tcpdump backgound process started for interface: ${adb_repiface}, port: ${adb_repport}, dir: ${adb_reportdir}, pid: ${bg_pid}"
|
||
else
|
||
f_log "info" "please set the reporting interface 'adb_repiface' and reporting directory 'adb_reportdir' manually"
|
||
fi
|
||
fi
|
||
fi
|
||
}
|
||
|
||
# check & set environment
|
||
#
|
||
f_env() {
|
||
: >"${adb_errorlog}"
|
||
read -r adb_starttime _ < "/proc/uptime"
|
||
adb_starttime="${adb_starttime%.*}"
|
||
f_log "info" "adblock instance started ::: action: ${adb_action}, priority: ${adb_nicelimit:-"0"}, pid: ${$}"
|
||
f_jsnup "processing"
|
||
f_extconf
|
||
f_temp
|
||
f_nftadd
|
||
json_init
|
||
if [ -s "${adb_customfeedfile}" ]; then
|
||
if json_load_file "${adb_customfeedfile}" >/dev/null 2>&1; then
|
||
return
|
||
else
|
||
f_log "info" "can't load adblock custom feed file"
|
||
fi
|
||
fi
|
||
if [ -s "${adb_feedfile}" ] && json_load_file "${adb_feedfile}" >/dev/null 2>&1; then
|
||
return
|
||
else
|
||
f_log "err" "can't load adblock feed file"
|
||
fi
|
||
}
|
||
|
||
# load adblock config
|
||
#
|
||
f_conf() {
|
||
config_cb() {
|
||
option_cb() {
|
||
local option="${1}" value="${2//\"/\\\"}"
|
||
|
||
case "${option}" in
|
||
*[!a-zA-Z0-9_]*)
|
||
;;
|
||
*)
|
||
eval "${option}=\"\${value}\""
|
||
;;
|
||
esac
|
||
}
|
||
list_cb() {
|
||
local append option="${1}" value="${2//\"/\\\"}"
|
||
|
||
case "${option}" in
|
||
*[!a-zA-Z0-9_]*)
|
||
;;
|
||
*)
|
||
eval "append=\"\${${option}}\""
|
||
if [ -n "${append}" ]; then
|
||
eval "${option}=\"\${append} \${value}\""
|
||
else
|
||
eval "${option}=\"\${value}\""
|
||
fi
|
||
;;
|
||
esac
|
||
}
|
||
}
|
||
config_load adblock
|
||
}
|
||
|
||
# domain validation
|
||
#
|
||
f_chkdom() {
|
||
local type prefix column separator check
|
||
|
||
case "${1}" in
|
||
"feed"|"local")
|
||
type="${1}"
|
||
case "${2}" in
|
||
[0-9])
|
||
prefix=""
|
||
column="${2}"
|
||
separator="${3:-[[:space:]]+}"
|
||
;;
|
||
*)
|
||
prefix="${2}"
|
||
column="${3}"
|
||
separator="${4:-[[:space:]]+}"
|
||
;;
|
||
esac
|
||
;;
|
||
"google")
|
||
type="${1}"
|
||
prefix=""
|
||
column="${2}"
|
||
separator="${3:-[[:space:]]+}"
|
||
;;
|
||
esac
|
||
|
||
check="${adb_lookupdomain//./\\.}"
|
||
"${adb_awkcmd}" -v type="${type}" -v pre="${prefix}" -v col="${column}" -v chk="${check}" -F "${separator}" '
|
||
{
|
||
domain = $col
|
||
# remove carriage returns and trim the input
|
||
gsub(/\r|^[[:space:]]+|[[:space:]]+$/, "", domain)
|
||
# add www. for google safe search
|
||
if (type=="google" && domain ~ /^\.+/) { sub(/^\.+/, "", domain); domain="www."domain }
|
||
# check optional search prefix
|
||
if (pre != "" && index($0, pre) != 1) next
|
||
# skip empty lines, comments and special domains
|
||
if (domain == "" || domain ~ ("^(#|localhost|loopback|" chk ")")) next
|
||
# no domain with trailing dot
|
||
if (substr(domain, length(domain), 1) == ".") next
|
||
# check total length (253 characters)
|
||
if (length(domain) > 253) next
|
||
n = split(domain, L, ".")
|
||
valid = 1
|
||
for (i = 1; i <= n; i++) {
|
||
l = L[i]
|
||
len = length(l)
|
||
# label length 1–63
|
||
if (len < 1 || len > 63) { valid = 0; break }
|
||
# no leading/trailing hyphen
|
||
if (l ~ /^-/ || l ~ /-$/) { valid = 0; break }
|
||
# ASCII + hyphen
|
||
if (l !~ /^[A-Za-z0-9-]+$/) { valid = 0; break }
|
||
}
|
||
# TLD must start with a letter or "xn--"
|
||
if (valid && L[n] !~ /^[A-Za-z]/ && L[n] !~ /^xn--/) valid = 0
|
||
if (valid) print tolower(domain)
|
||
}'
|
||
|
||
f_log "debug" "f_chkdom ::: name: ${src_name}, type: ${type}, prefix: ${prefix:-"-"}, column: ${column:-"-"}, separator: ${separator:-"-"}"
|
||
}
|
||
|
||
# status helper function
|
||
#
|
||
f_char() {
|
||
local result input="${1}"
|
||
|
||
if [ "${input}" = "1" ]; then
|
||
result="✔"
|
||
else
|
||
result="✘"
|
||
fi
|
||
printf '%s' "${result}"
|
||
}
|
||
|
||
# load dns backend config
|
||
#
|
||
f_dns() {
|
||
local dns dns_list dns_section dns_info free_mem dir
|
||
|
||
free_mem="$("${adb_awkcmd}" '/^MemAvailable/{printf "%s",int($2/1000)}' "/proc/meminfo" 2>>"${adb_errorlog}")"
|
||
if [ "${adb_action}" = "boot" ] && [ -z "${adb_trigger}" ]; then
|
||
sleep ${adb_triggerdelay:-"5"}
|
||
fi
|
||
|
||
if [ -z "${adb_dns}" ]; then
|
||
dns_list="knot-resolver bind-server unbound-daemon smartdns dnsmasq-full dnsmasq-dhcpv6 dnsmasq"
|
||
for dns in ${dns_list}; do
|
||
if printf '%s' "${adb_packages}" | "${adb_jsoncmd}" -ql1 -e "@.packages[\"${dns}\"]" >/dev/null 2>&1; then
|
||
case "${dns}" in
|
||
"knot-resolver")
|
||
dns="kresd"
|
||
;;
|
||
"bind-server")
|
||
dns="named"
|
||
;;
|
||
"unbound-daemon")
|
||
dns="unbound"
|
||
;;
|
||
"dnsmasq-full" | "dnsmasq-dhcpv6")
|
||
dns="dnsmasq"
|
||
;;
|
||
esac
|
||
|
||
if [ -x "$(command -v "${dns}")" ]; then
|
||
adb_dns="${dns}"
|
||
uci_set adblock global adb_dns "${dns}"
|
||
f_uci "adblock"
|
||
break
|
||
fi
|
||
fi
|
||
done
|
||
fi
|
||
|
||
if [ "${adb_dns}" != "raw" ] && [ ! -x "$(command -v "${adb_dns}")" ]; then
|
||
f_log "err" "dns backend not found, please set 'adb_dns' manually"
|
||
fi
|
||
|
||
case "${adb_dns}" in
|
||
"dnsmasq")
|
||
adb_dnscachecmd=""
|
||
adb_dnsinstance="${adb_dnsinstance:-"0"}"
|
||
adb_dnsuser="dnsmasq"
|
||
adb_dnsdir="${adb_dnsdir:-""}"
|
||
if [ -z "${adb_dnsdir}" ]; then
|
||
dns_section="$("${adb_ubuscmd}" -S call uci get "{\"config\":\"dhcp\", \"section\":\"@dnsmasq[${adb_dnsinstance}]\", \"type\":\"dnsmasq\"}" 2>>"${adb_errorlog}")"
|
||
dns_info="$(printf '%s' "${dns_section}" | "${adb_jsoncmd}" -l1 -e '@.values["confdir"]')"
|
||
if [ -n "${dns_info}" ]; then
|
||
adb_dnsdir="${dns_info}"
|
||
else
|
||
dns_info="$(printf '%s' "${dns_section}" | "${adb_jsoncmd}" -l1 -e '@.values[".name"]')"
|
||
[ -n "${dns_info}" ] && adb_dnsdir="/tmp/dnsmasq.${dns_info}.d"
|
||
fi
|
||
fi
|
||
adb_dnsheader=""
|
||
adb_dnsdeny="1"
|
||
adb_dnsallow="1"
|
||
adb_dnssafesearch="1"
|
||
adb_dnsstop="address=/#/\nlocal=/#/"
|
||
f_dnsdeny() {
|
||
"${adb_awkcmd}" '{print "local=/"$0"/"}' "${@}"
|
||
}
|
||
f_dnsallow() {
|
||
"${adb_awkcmd}" '{print "local=/"$0"/#"}' "${@}"
|
||
}
|
||
f_dnssafesearch() {
|
||
local item="${1}"
|
||
|
||
shift
|
||
"${adb_awkcmd}" -v item="${item}" '{print "address=/"$0"/"item"";print "local=/"$0"/"}' "${@}"
|
||
}
|
||
;;
|
||
"unbound")
|
||
adb_dnscachecmd="$(command -v unbound-control)"
|
||
adb_dnsinstance=""
|
||
adb_dnsuser="unbound"
|
||
adb_dnsdir="${adb_dnsdir:-"/var/lib/unbound"}"
|
||
adb_dnsheader=""
|
||
adb_dnsdeny="1"
|
||
adb_dnsallow="1"
|
||
adb_dnssafesearch="1"
|
||
adb_dnsstop="local-zone: \".\" always_nxdomain"
|
||
f_dnsdeny() {
|
||
"${adb_awkcmd}" '{print "local-zone: \042"$0"\042 always_nxdomain"}' "${@}"
|
||
}
|
||
f_dnsallow() {
|
||
"${adb_awkcmd}" '{print "local-zone: \042"$0"\042 always_transparent"}' "${@}"
|
||
}
|
||
f_dnssafesearch() {
|
||
local item="${1}"
|
||
|
||
shift
|
||
"${adb_awkcmd}" -v item="${item}" \
|
||
'{type="AAAA";if(match(item,/^([0-9]{1,3}\.){3}[0-9]{1,3}$/)){type="A"}}{print "local-data: \042"$0" "type" "item"\042"}' "${@}"
|
||
}
|
||
;;
|
||
"named")
|
||
adb_dnscachecmd="$(command -v rndc)"
|
||
adb_dnsinstance=""
|
||
adb_dnsuser="bind"
|
||
adb_dnsdir="${adb_dnsdir:-"/var/lib/bind"}"
|
||
adb_dnsheader="\$TTL 2h\n@ IN SOA localhost. root.localhost. (1 6h 1h 1w 2h)\n IN NS localhost.\n"
|
||
adb_dnsdeny="1"
|
||
adb_dnsallow="1"
|
||
adb_dnssafesearch="1"
|
||
adb_dnsstop="* CNAME ."
|
||
f_dnsdeny() {
|
||
"${adb_awkcmd}" '{print ""$0" CNAME .\n*."$0" CNAME ."}' "${@}"
|
||
}
|
||
f_dnsallow() {
|
||
"${adb_awkcmd}" '{print ""$0" CNAME rpz-passthru.\n*."$0" CNAME rpz-passthru."}' "${@}"
|
||
}
|
||
f_dnssafesearch() {
|
||
local item="${1}"
|
||
|
||
shift
|
||
"${adb_awkcmd}" -v item="${item}" '{print ""$0" CNAME "item".\n*."$0" CNAME "item"."}' "${@}"
|
||
}
|
||
;;
|
||
"kresd")
|
||
adb_dnscachecmd=""
|
||
adb_dnsinstance=""
|
||
adb_dnsuser="root"
|
||
adb_dnsdir="${adb_dnsdir:-"/tmp/kresd"}"
|
||
adb_dnsheader="\$TTL 2h\n@ IN SOA localhost. root.localhost. (1 6h 1h 1w 2h)\n"
|
||
adb_dnsdeny="1"
|
||
adb_dnsallow="1"
|
||
adb_dnssafesearch="1"
|
||
adb_dnsstop="* CNAME ."
|
||
f_dnsdeny() {
|
||
"${adb_awkcmd}" '{print ""$0" CNAME .\n*."$0" CNAME ."}' "${@}"
|
||
}
|
||
f_dnsallow() {
|
||
"${adb_awkcmd}" '{print ""$0" CNAME rpz-passthru.\n*."$0" CNAME rpz-passthru."}' "${@}"
|
||
}
|
||
f_dnssafesearch() {
|
||
local item="${1}"
|
||
|
||
shift
|
||
"${adb_awkcmd}" -v item="${item}" '{print ""$0" CNAME "item".\n*."$0" CNAME "item"."}' "${@}"
|
||
}
|
||
;;
|
||
"smartdns")
|
||
adb_dnscachecmd=""
|
||
adb_dnsinstance="${adb_dnsinstance:-"0"}"
|
||
adb_dnsuser="root"
|
||
adb_dnsdir="${adb_dnsdir:-"/tmp/smartdns"}"
|
||
adb_dnsheader=""
|
||
adb_dnsdeny="1"
|
||
adb_dnsallow="1"
|
||
adb_dnssafesearch="1"
|
||
adb_dnsstop="address #"
|
||
f_dnsdeny() {
|
||
"${adb_awkcmd}" '{print "address /"$0"/#"}' "${@}"
|
||
}
|
||
f_dnsallow() {
|
||
"${adb_awkcmd}" '{print "address /"$0"/-"}' "${@}"
|
||
}
|
||
f_dnssafesearch() {
|
||
local item="${1}"
|
||
|
||
shift
|
||
"${adb_awkcmd}" -v item="${item}" '{print "cname /"$0"/"item""}' "${@}"
|
||
}
|
||
;;
|
||
"raw")
|
||
adb_dnscachecmd=""
|
||
adb_dnsinstance=""
|
||
adb_dnsuser="root"
|
||
adb_dnsdir="${adb_dnsdir:-"/tmp"}"
|
||
adb_dnsheader=""
|
||
adb_dnsdeny=""
|
||
adb_dnsallow=""
|
||
adb_dnssafesearch=""
|
||
adb_dnsstop=""
|
||
;;
|
||
esac
|
||
|
||
if [ "${adb_dnsshift}" = "0" ]; then
|
||
adb_finaldir="${adb_dnsdir}"
|
||
else
|
||
adb_finaldir="${adb_backupdir}"
|
||
fi
|
||
if [ "${adb_action}" != "stop" ]; then
|
||
for dir in "${adb_dnsdir:-"/tmp"}" "${adb_backupdir:-"/tmp"}"; do
|
||
[ ! -d "${dir}" ] && mkdir -p "${dir}"
|
||
done
|
||
if [ "${adb_dnsflush}" = "1" ] || [ "${free_mem}" -lt "64" ]; then
|
||
printf '%b' "${adb_dnsheader}" >"${adb_finaldir}/${adb_dnsfile}"
|
||
f_dnsup
|
||
elif [ ! -f "${adb_finaldir}/${adb_dnsfile}" ]; then
|
||
printf '%b' "${adb_dnsheader}" >"${adb_finaldir}/${adb_dnsfile}"
|
||
fi
|
||
fi
|
||
|
||
# check if adblock is enabled
|
||
#
|
||
if [ "${adb_enabled}" = "0" ]; then
|
||
f_extconf
|
||
f_temp
|
||
f_nftremove
|
||
f_rmdns
|
||
f_jsnup "disabled"
|
||
f_log "info" "adblock is currently disabled, please set the config option 'adb_enabled' to '1' to use this service"
|
||
exit 0
|
||
fi
|
||
|
||
f_log "debug" "f_dns ::: dns: ${adb_dns}, dns_instance: ${adb_dnsinstance:-"-"}, dns_user: ${adb_dnsuser}, dns_dir: ${adb_dnsdir}, backup_dir: ${adb_backupdir}, final_dir: ${adb_finaldir}"
|
||
}
|
||
|
||
# load fetch utility
|
||
#
|
||
f_fetch() {
|
||
local fetch fetch_list insecure update="0"
|
||
|
||
adb_fetchcmd="$(command -v "${adb_fetchcmd}")"
|
||
if [ ! -x "${adb_fetchcmd}" ]; then
|
||
fetch_list="curl wget-ssl libustream-openssl libustream-wolfssl libustream-mbedtls"
|
||
for fetch in ${fetch_list}; do
|
||
case "${adb_packages}" in *"\"${fetch}"*)
|
||
case "${fetch}" in
|
||
"wget-ssl")
|
||
fetch="wget"
|
||
;;
|
||
"libustream-openssl" | "libustream-wolfssl" | "libustream-mbedtls")
|
||
fetch="uclient-fetch"
|
||
;;
|
||
esac
|
||
if [ -x "$(command -v "${fetch}")" ]; then
|
||
update="1"
|
||
adb_fetchcmd="$(command -v "${fetch}")"
|
||
uci_set adblock global adb_fetchcmd "${fetch}"
|
||
f_uci "adblock"
|
||
break
|
||
fi
|
||
;;
|
||
esac
|
||
done
|
||
fi
|
||
|
||
[ ! -x "${adb_fetchcmd}" ] && f_log "err" "download utility with SSL support not found, please set 'adb_fetchcmd' manually"
|
||
|
||
case "${adb_fetchcmd##*/}" in
|
||
"curl")
|
||
[ "${adb_fetchinsecure}" = "1" ] && insecure="--insecure"
|
||
adb_fetchparm="${adb_fetchparm:-"${insecure} --connect-timeout 20 --fail --silent --show-error --location -o"}"
|
||
adb_etagparm="--connect-timeout 5 --silent --location --head"
|
||
adb_geoparm="--connect-timeout 5 --silent --location"
|
||
;;
|
||
"wget")
|
||
[ "${adb_fetchinsecure}" = "1" ] && insecure="--no-check-certificate"
|
||
adb_fetchparm="${adb_fetchparm:-"${insecure} --no-cache --no-cookies --max-redirect=0 --timeout=20 -O"}"
|
||
adb_etagparm="--timeout=5 --spider --server-response"
|
||
adb_geoparm="--timeout=5 --quiet -O-"
|
||
;;
|
||
"uclient-fetch")
|
||
[ "${adb_fetchinsecure}" = "1" ] && insecure="--no-check-certificate"
|
||
adb_fetchparm="${adb_fetchparm:-"${insecure} --timeout=20 -O"}"
|
||
adb_geoparm="--timeout=5 --quiet -O-"
|
||
;;
|
||
esac
|
||
|
||
f_log "debug" "f_fetch ::: update: ${update}, cmd: ${adb_fetchcmd:-"-"}"
|
||
}
|
||
|
||
# create temporary files, directories and set dependent options
|
||
#
|
||
f_temp() {
|
||
if [ -d "${adb_basedir}" ]; then
|
||
adb_tmpdir="$(mktemp -p "${adb_basedir}" -d)"
|
||
adb_tmpload="$(mktemp -p "${adb_tmpdir}" -tu)"
|
||
adb_tmpfile="$(mktemp -p "${adb_tmpdir}" -tu)"
|
||
adb_srtopts="--temporary-directory=${adb_tmpdir} --compress-program=gzip --parallel=${adb_cores}"
|
||
else
|
||
f_log "err" "the base directory '${adb_basedir}' does not exist/is not mounted yet, please create the directory or raise the 'adb_triggerdelay' to defer the adblock start"
|
||
fi
|
||
[ ! -s "${adb_pidfile}" ] && printf '%s' "${$}" >"${adb_pidfile}"
|
||
}
|
||
|
||
# remove temporary files and directories
|
||
#
|
||
f_rmtemp() {
|
||
[ -f "${adb_errorlog}" ] && [ ! -s "${adb_errorlog}" ] && "${adb_rmcmd}" -f "${adb_errorlog}"
|
||
[ -d "${adb_tmpdir}" ] && "${adb_rmcmd}" -rf "${adb_tmpdir}"
|
||
: >"${adb_pidfile}"
|
||
}
|
||
|
||
# remove dns related files
|
||
#
|
||
f_rmdns() {
|
||
printf '%b' "${adb_dnsheader}" >"${adb_finaldir}/${adb_dnsfile}"
|
||
f_dnsup
|
||
f_rmtemp
|
||
if [ -d "${adb_backupdir}" ] && { [ "${adb_action}" = "stop" ] || [ "${adb_enabled}" = "0" ]; }; then
|
||
"${adb_findcmd}" "${adb_backupdir}" -maxdepth 1 -type f -name '*.gz' -exec "${adb_rmcmd}" -f {} +
|
||
fi
|
||
}
|
||
|
||
# commit uci changes
|
||
#
|
||
f_uci() {
|
||
local config="${1}"
|
||
|
||
if [ -n "$(uci -q changes "${config}")" ]; then
|
||
uci_commit "${config}"
|
||
if [ "${config}" = "resolver" ]; then
|
||
printf '%b' "${adb_dnsheader}" >"${adb_finaldir}/${adb_dnsfile}"
|
||
adb_cnt="0"
|
||
f_jsnup "processing"
|
||
"/etc/init.d/${adb_dns}" reload >/dev/null 2>&1
|
||
fi
|
||
fi
|
||
}
|
||
|
||
# get list counter
|
||
#
|
||
f_count() {
|
||
local mode="${1}" file="${2}" var="${3}"
|
||
|
||
adb_cnt="0"
|
||
if [ -s "${file}" ]; then
|
||
adb_cnt="$("${adb_wccmd}" -l 2>>"${adb_errorlog}" <"${file}")"
|
||
if [ -n "${var}" ]; then
|
||
printf '%s' "${adb_cnt}"
|
||
else
|
||
if [ "${mode}" = "final" ]; then
|
||
if [ -s "${adb_tmpdir}/tmp.add.allowlist" ]; then
|
||
adb_cnt="$((adb_cnt - $("${adb_wccmd}" -l 2>>"${adb_errorlog}" <"${adb_tmpdir}/tmp.add.allowlist")))"
|
||
fi
|
||
for file in "${adb_tmpdir}/tmp.safesearch".*; do
|
||
if [ -r "${file}" ]; then
|
||
adb_cnt="$((adb_cnt - $("${adb_wccmd}" -l 2>>"${adb_errorlog}" <"${file}")))"
|
||
fi
|
||
done
|
||
[ -n "${adb_dnsheader}" ] && adb_cnt="$(((adb_cnt - $(printf '%b' "${adb_dnsheader}" | "${adb_grepcmd}" -c "^")) / 2))"
|
||
fi
|
||
fi
|
||
fi
|
||
}
|
||
|
||
# set external config options
|
||
#
|
||
f_extconf() {
|
||
local config
|
||
|
||
case "${adb_dns}" in
|
||
"dnsmasq")
|
||
config="dhcp"
|
||
if [ "${adb_dnsshift}" = "1" ] &&
|
||
! uci_get ${config} @dnsmasq[${adb_dnsinstance}] addnmount | "${adb_grepcmd}" -q "${adb_backupdir}"; then
|
||
uci -q add_list ${config}.@dnsmasq[${adb_dnsinstance}].addnmount="${adb_backupdir}"
|
||
elif [ "${adb_dnsshift}" = "0" ] &&
|
||
uci_get ${config} @dnsmasq[${adb_dnsinstance}] addnmount | "${adb_grepcmd}" -q "${adb_backupdir}"; then
|
||
uci -q del_list ${config}.@dnsmasq[${adb_dnsinstance}].addnmount="${adb_backupdir}"
|
||
fi
|
||
;;
|
||
"kresd")
|
||
config="resolver"
|
||
if [ "${adb_enabled}" = "1" ] &&
|
||
! uci_get ${config} kresd rpz_file | "${adb_grepcmd}" -q "${adb_dnsdir}/${adb_dnsfile}"; then
|
||
uci -q add_list ${config}.kresd.rpz_file="${adb_dnsdir}/${adb_dnsfile}"
|
||
elif [ "${adb_enabled}" = "0" ] &&
|
||
uci_get ${config} kresd rpz_file | "${adb_grepcmd}" -q "${adb_dnsdir}/${adb_dnsfile}"; then
|
||
uci -q del_list ${config}.kresd.rpz_file="${adb_dnsdir}/${adb_dnsfile}"
|
||
fi
|
||
;;
|
||
"smartdns")
|
||
config="smartdns"
|
||
if [ "${adb_enabled}" = "1" ] &&
|
||
! uci_get ${config} @${config}[${adb_dnsinstance}] conf_files | "${adb_grepcmd}" -q "${adb_dnsdir}/${adb_dnsfile}"; then
|
||
uci -q add_list ${config}.@${config}[${adb_dnsinstance}].conf_files="${adb_dnsdir}/${adb_dnsfile}"
|
||
elif [ "${adb_enabled}" = "0" ] &&
|
||
uci_get ${config} @${config}[${adb_dnsinstance}] conf_files | "${adb_grepcmd}" -q "${adb_dnsdir}/${adb_dnsfile}"; then
|
||
uci -q del_list ${config}.@${config}[${adb_dnsinstance}].conf_files="${adb_dnsdir}/${adb_dnsfile}"
|
||
fi
|
||
;;
|
||
esac
|
||
f_uci "${config}"
|
||
}
|
||
|
||
# restart dns backend
|
||
#
|
||
f_dnsup() {
|
||
local restart_rc nft_rc cnt="0" out_rc="4"
|
||
|
||
if [ "${adb_dns}" = "raw" ] || [ -z "${adb_dns}" ]; then
|
||
out_rc="0"
|
||
else
|
||
# load external dns bridge
|
||
#
|
||
if { [ -n "${adb_bridgednsv4}" ] || [ -n "${adb_bridgednsv6}" ]; } && [ "${adb_nftbridge}" = "1" ]; then
|
||
if "${adb_nftcmd}" list chain inet adblock dns-bridge >/dev/null 2>&1; then
|
||
if [ -n "${adb_bridgednsv4}" ]; then
|
||
"${adb_nftcmd}" add rule inet adblock dns-bridge meta nfproto ipv4 meta l4proto { udp, tcp } th dport 53 counter dnat to ${adb_bridgednsv4}:53 2>>"${adb_errorlog}"
|
||
nft_rc="${?}"
|
||
fi
|
||
if [ -n "${adb_bridgednsv6}" ]; then
|
||
"${adb_nftcmd}" add rule inet adblock dns-bridge meta nfproto ipv6 meta l4proto { udp, tcp } th dport 53 counter dnat to [${adb_bridgednsv6}]:53 2>>"${adb_errorlog}"
|
||
nft_rc="$(( nft_rc + $? ))"
|
||
fi
|
||
if [ "${nft_rc}" = "0" ]; then
|
||
f_log "info" "external DNS bridge loaded: ${adb_bridgednsv4:-"-"} / ${adb_bridgednsv6:-"-"}"
|
||
else
|
||
f_log "err" "failed to load external DNS bridge: ${adb_bridgednsv4:-"-"} / ${adb_bridgednsv6:-"-"}"
|
||
fi
|
||
fi
|
||
fi
|
||
# restart dns backend
|
||
#
|
||
if [ "${adb_dnsflush}" = "0" ]; then
|
||
case "${adb_dns}" in
|
||
"unbound")
|
||
if [ -x "${adb_dnscachecmd}" ] && [ -d "${adb_tmpdir}" ] && [ -f "${adb_dnsdir}/unbound.conf" ]; then
|
||
"${adb_dnscachecmd}" -c "${adb_dnsdir}/unbound.conf" dump_cache >"${adb_tmpdir}/adb_cache.dump" 2>>"${adb_errorlog}"
|
||
fi
|
||
"/etc/init.d/${adb_dns}" restart >/dev/null 2>&1
|
||
restart_rc="${?}"
|
||
;;
|
||
"named")
|
||
if [ -x "${adb_dnscachecmd}" ] && [ -f "/etc/bind/rndc.conf" ]; then
|
||
"${adb_dnscachecmd}" -c "/etc/bind/rndc.conf" reload >/dev/null 2>&1
|
||
restart_rc="${?}"
|
||
fi
|
||
if [ -z "${restart_rc}" ] || { [ -n "${restart_rc}" ] && [ "${restart_rc}" != "0" ]; }; then
|
||
"/etc/init.d/${adb_dns}" restart >/dev/null 2>&1
|
||
restart_rc="${?}"
|
||
fi
|
||
;;
|
||
*)
|
||
"/etc/init.d/${adb_dns}" restart >/dev/null 2>&1
|
||
restart_rc="${?}"
|
||
;;
|
||
esac
|
||
fi
|
||
if [ -z "${restart_rc}" ]; then
|
||
"/etc/init.d/${adb_dns}" restart >/dev/null 2>&1
|
||
restart_rc="${?}"
|
||
fi
|
||
fi
|
||
|
||
# check if dns backend is responsive, restore dns cache for unbound and get dns backend pid
|
||
#
|
||
if [ "${restart_rc}" = "0" ]; then
|
||
while [ "${cnt}" -le "${adb_dnstimeout}" ]; do
|
||
if "${adb_lookupcmd}" "${adb_lookupdomain}." >/dev/null 2>&1; then
|
||
out_rc="0"
|
||
break
|
||
fi
|
||
cnt="$((cnt + 1))"
|
||
sleep 2
|
||
done
|
||
if [ "${out_rc}" = "0" ] && [ "${adb_dns}" = "unbound" ]; then
|
||
if [ -x "${adb_dnscachecmd}" ] && [ -d "${adb_tmpdir}" ] && [ -s "${adb_tmpdir}/adb_cache.dump" ]; then
|
||
"${adb_dnscachecmd}" -c "${adb_dnsdir}/unbound.conf" load_cache <"${adb_tmpdir}/adb_cache.dump" >/dev/null 2>&1
|
||
restart_rc="${?}"
|
||
fi
|
||
fi
|
||
fi
|
||
|
||
# remove external dns bridge
|
||
#
|
||
if [ "${adb_nftbridge}" = "1" ] && "${adb_nftcmd}" list chain inet adblock dns-bridge >/dev/null 2>&1; then
|
||
"${adb_nftcmd}" flush chain inet adblock dns-bridge 2>>"${adb_errorlog}"
|
||
nft_rc="${?}"
|
||
if [ "${nft_rc}" = "0" ]; then
|
||
f_log "info" "external DNS bridge removed"
|
||
else
|
||
f_log "err" "failed to remove external DNS bridge"
|
||
fi
|
||
fi
|
||
|
||
f_log "debug" "f_dnsup ::: dns: ${adb_dns}, cache_cmd: ${adb_dnscachecmd:-"-"}, lookup_domain: ${adb_lookupdomain:-"-"}, restart_rc: ${restart_rc:-"-"}, dns_flush: ${adb_dnsflush}, dns_timeout: ${adb_dnstimeout}, dns_cnt: ${cnt}, nft_rc: ${nft_rc:-"-"}, rc: ${out_rc}"
|
||
return "${out_rc}"
|
||
}
|
||
|
||
# handle etag http header
|
||
#
|
||
f_etag() {
|
||
local http_head http_code etag_id etag_cnt out_rc="4" feed="${1}" feed_url="${2}" feed_suffix="${3}" feed_cnt="${4:-"1"}"
|
||
|
||
[ ! -f "${adb_backupdir}/adblock.etag" ] && : >"${adb_backupdir}/adblock.etag"
|
||
http_head="$("${adb_fetchcmd}" ${adb_etagparm} "${feed_url}${feed_suffix}" 2>&1)"
|
||
http_code="$(printf '%s' "${http_head}" | "${adb_awkcmd}" 'tolower($0)~/^http\/[0123\.]+ /{printf "%s",$2}')"
|
||
etag_id="$(printf '%s' "${http_head}" | "${adb_awkcmd}" 'tolower($0)~/^[[:space:]]*etag: /{gsub("\"","");printf "%s",$2}')"
|
||
if [ -z "${etag_id}" ]; then
|
||
etag_id="$(printf '%s' "${http_head}" | "${adb_awkcmd}" 'tolower($0)~/^[[:space:]]*last-modified: /{gsub(/[Ll]ast-[Mm]odified:|[[:space:]]|,|:/,"");printf "%s\n",$1}')"
|
||
fi
|
||
etag_cnt="$("${adb_grepcmd}" -c "^${feed} " "${adb_backupdir}/adblock.etag")"
|
||
if [ "${http_code}" = "200" ] && [ "${etag_cnt}" = "${feed_cnt}" ] && [ -n "${etag_id}" ] &&
|
||
"${adb_grepcmd}" -q "^${feed} ${feed_suffix}[[:space:]]\+${etag_id}\$" "${adb_backupdir}/adblock.etag"; then
|
||
out_rc="0"
|
||
elif [ -n "${etag_id}" ]; then
|
||
if [ "${feed_cnt}" -lt "${etag_cnt}" ]; then
|
||
"${adb_sedcmd}" -i "/^${feed} /d" "${adb_backupdir}/adblock.etag"
|
||
else
|
||
"${adb_sedcmd}" -i "/^${feed} ${feed_suffix//\//\\/}/d" "${adb_backupdir}/adblock.etag"
|
||
fi
|
||
printf '%-80s%s\n' "${feed} ${feed_suffix}" "${etag_id}" >>"${adb_backupdir}/adblock.etag"
|
||
out_rc="2"
|
||
fi
|
||
|
||
f_log "debug" "f_etag ::: feed: ${feed}, suffix: ${feed_suffix:-"-"}, http_code: ${http_code:-"-"}, feed/etag: ${feed_cnt}/${etag_cnt:-"0"}, rc: ${out_rc}"
|
||
return "${out_rc}"
|
||
}
|
||
|
||
# add adblock-related nft rules
|
||
#
|
||
f_nftadd() {
|
||
local devices device port file="${adb_tmpdir}/adb_nft.add"
|
||
|
||
# only proceed if at least one feature is enabled
|
||
#
|
||
if [ "${adb_nftallow}" = "0" ] && [ "${adb_nftblock}" = "0" ] \
|
||
&& [ "${adb_nftremote}" = "0" ] && [ "${adb_nftforce}" = "0" ] \
|
||
&& [ "${adb_nftbridge}" = "0" ]; then
|
||
return
|
||
fi
|
||
|
||
# remove existing adblock-related nft rules on restart
|
||
#
|
||
[ "${adb_action}" = "restart" ] && f_nftremove
|
||
|
||
# do not proceed if adblock-related nft rules already exists
|
||
#
|
||
if "${adb_nftcmd}" -t list table inet adblock >/dev/null 2>&1; then
|
||
return
|
||
fi
|
||
|
||
# do not proceed if action is stop/suspend/resume
|
||
#
|
||
if [ "${adb_action}" = "stop" ] || [ "${adb_action}" = "suspend" ] || [ "${adb_action}" = "resume" ]; then
|
||
return
|
||
fi
|
||
|
||
# prepare nftables rules for adblock features
|
||
#
|
||
{
|
||
# nft header (tables, sets, base and regular chains)
|
||
#
|
||
printf '%s\n\n' "#!${adb_nftcmd} -f"
|
||
printf '%s\n' "add table inet adblock"
|
||
|
||
# allow Set
|
||
#
|
||
if [ "${adb_nftallow}" = "1" ] && [ -n "${adb_nftmacallow}" ]; then
|
||
printf '%s\n' "add set inet adblock mac_allow { type ether_addr; flags interval; auto-merge; elements = { ${adb_nftmacallow// /, } }; }"
|
||
fi
|
||
|
||
# remote allow Set with timeout, for MACs that should be temporary allowed to bypass dns blocking
|
||
#
|
||
if [ "${adb_nftremote}" = "1" ] && [ -n "${adb_nftmacremote}" ]; then
|
||
printf '%s\n' "add set inet adblock mac_remote { type ether_addr; flags timeout; timeout ${adb_nftremotetimeout}m; }"
|
||
fi
|
||
|
||
# adblock pre-routing chain for allow/block rules
|
||
#
|
||
if [ "${adb_nftblock}" = "1" ] && [ -n "${adb_nftmacblock}" ]; then
|
||
printf '%s\n' "add set inet adblock mac_block { type ether_addr; flags interval; auto-merge; elements = { ${adb_nftmacblock// /, } }; }"
|
||
fi
|
||
printf '%s\n' "add chain inet adblock pre-routing { type nat hook prerouting priority -150; policy accept; }"
|
||
printf '%s\n' "add chain inet adblock _reject"
|
||
|
||
# dns-bridge base chain
|
||
#
|
||
printf '%s\n' "add chain inet adblock dns-bridge { type nat hook prerouting priority -160; policy accept; }"
|
||
|
||
# reject chain rules
|
||
#
|
||
printf '%s\n' "add rule inet adblock _reject meta l4proto tcp counter reject with tcp reset"
|
||
printf '%s\n' "add rule inet adblock _reject counter reject with icmpx host-unreachable"
|
||
|
||
# external allow rules
|
||
#
|
||
if [ "${adb_nftallow}" = "1" ]; then
|
||
if [ -n "${adb_nftmacallow}" ]; then
|
||
[ -n "${adb_allowdnsv4}" ] && printf '%s\n' "add rule inet adblock pre-routing meta nfproto ipv4 ether saddr @mac_allow meta l4proto { udp, tcp } th dport 53 counter dnat to ${adb_allowdnsv4}:53"
|
||
[ -n "${adb_allowdnsv6}" ] && printf '%s\n' "add rule inet adblock pre-routing meta nfproto ipv6 ether saddr @mac_allow meta l4proto { udp, tcp } th dport 53 counter dnat to [${adb_allowdnsv6}]:53"
|
||
fi
|
||
for device in ${adb_nftdevallow}; do
|
||
[ -n "${adb_allowdnsv4}" ] && printf '%s\n' "add rule inet adblock pre-routing iifname \"${device}\" meta nfproto ipv4 meta l4proto { udp, tcp } th dport 53 counter dnat to ${adb_allowdnsv4}:53"
|
||
[ -n "${adb_allowdnsv6}" ] && printf '%s\n' "add rule inet adblock pre-routing iifname \"${device}\" meta nfproto ipv6 meta l4proto { udp, tcp } th dport 53 counter dnat to [${adb_allowdnsv6}]:53"
|
||
done
|
||
f_log "info" "adblock-related nft allow rules prepared for external DNS ${adb_allowdnsv4:-"-"} / ${adb_allowdnsv6:-"-"}"
|
||
fi
|
||
|
||
# external remote allow rules
|
||
#
|
||
if [ "${adb_nftremote}" = "1" ] && [ -n "${adb_nftmacremote}" ]; then
|
||
[ -n "${adb_remotednsv4}" ] && printf '%s\n' "add rule inet adblock pre-routing meta nfproto ipv4 ether saddr @mac_remote meta l4proto { udp, tcp } th dport 53 counter dnat to ${adb_remotednsv4}:53"
|
||
[ -n "${adb_remotednsv6}" ] && printf '%s\n' "add rule inet adblock pre-routing meta nfproto ipv6 ether saddr @mac_remote meta l4proto { udp, tcp } th dport 53 counter dnat to [${adb_remotednsv6}]:53"
|
||
f_log "info" "adblock-related nft remote allow rules prepared for external DNS ${adb_remotednsv4:-"-"} / ${adb_remotednsv6:-"-"} with timeout of ${adb_nftremotetimeout} minutes"
|
||
fi
|
||
|
||
# external block rules
|
||
#
|
||
if [ "${adb_nftblock}" = "1" ]; then
|
||
if [ -n "${adb_nftmacblock}" ]; then
|
||
[ -n "${adb_blockdnsv4}" ] && printf '%s\n' "add rule inet adblock pre-routing meta nfproto ipv4 ether saddr @mac_block meta l4proto { udp, tcp } th dport 53 counter dnat to ${adb_blockdnsv4}:53"
|
||
[ -n "${adb_blockdnsv6}" ] && printf '%s\n' "add rule inet adblock pre-routing meta nfproto ipv6 ether saddr @mac_block meta l4proto { udp, tcp } th dport 53 counter dnat to [${adb_blockdnsv6}]:53"
|
||
fi
|
||
for device in ${adb_nftdevblock}; do
|
||
[ -n "${adb_blockdnsv4}" ] && printf '%s\n' "add rule inet adblock pre-routing iifname \"${device}\" meta nfproto ipv4 meta l4proto { udp, tcp } th dport 53 counter dnat to ${adb_blockdnsv4}:53"
|
||
[ -n "${adb_blockdnsv6}" ] && printf '%s\n' "add rule inet adblock pre-routing iifname \"${device}\" meta nfproto ipv6 meta l4proto { udp, tcp } th dport 53 counter dnat to [${adb_blockdnsv6}]:53"
|
||
done
|
||
f_log "info" "adblock-related nft block rules prepared for external DNS ${adb_blockdnsv4:-"-"} / ${adb_blockdnsv6:-"-"}"
|
||
fi
|
||
|
||
# local dns enforcement
|
||
#
|
||
if [ "${adb_nftforce}" = "1" ]; then
|
||
|
||
# device/vlan exceptions
|
||
#
|
||
for device in ${adb_nftdevallow} ${adb_nftdevblock}; do
|
||
case " ${devices} " in
|
||
*" ${device} "*)
|
||
;;
|
||
*) [ -n "${devices}" ] && devices="${devices} ${device}" || devices="${device}"
|
||
printf '%s\n' "add rule inet adblock pre-routing iifname \"${device}\" return"
|
||
;;
|
||
esac
|
||
done
|
||
|
||
# mac exceptions
|
||
#
|
||
for device in ${adb_nftdevforce}; do
|
||
if [ "${adb_nftallow}" = "1" ] && [ -n "${adb_nftmacallow}" ]; then
|
||
printf '%s\n' "add rule inet adblock pre-routing iifname \"${device}\" ether saddr @mac_allow return"
|
||
fi
|
||
if [ "${adb_nftblock}" = "1" ] && [ -n "${adb_nftmacblock}" ]; then
|
||
printf '%s\n' "add rule inet adblock pre-routing iifname \"${device}\" ether saddr @mac_block return"
|
||
fi
|
||
|
||
# dns enforce rules
|
||
#
|
||
for port in ${adb_nftportforce}; do
|
||
if [ "${port}" = "53" ]; then
|
||
printf '%s\n' "add rule inet adblock pre-routing iifname \"${device}\" meta nfproto { ipv4, ipv6 } meta l4proto { udp, tcp } th dport ${port} counter redirect to :${port}"
|
||
else
|
||
printf '%s\n' "add rule inet adblock pre-routing iifname \"${device}\" meta nfproto { ipv4, ipv6 } meta l4proto { udp, tcp } th dport ${port} counter goto _reject"
|
||
fi
|
||
done
|
||
done
|
||
f_log "info" "adblock-related nft local DNS enforcement rules prepared for devices: ${adb_nftdevforce// /, } and ports: ${adb_nftportforce// /, }"
|
||
fi
|
||
} >"${file}"
|
||
if "${adb_nftcmd}" -f "${file}" 2>>"${adb_errorlog}"; then
|
||
f_log "info" "adblock-related nft rules loaded"
|
||
else
|
||
f_log "err" "failed to load adblock-related nft rules"
|
||
fi
|
||
}
|
||
|
||
# remove adblock-related nft rules
|
||
#
|
||
f_nftremove() {
|
||
local file="${adb_tmpdir}/adb_nft.remove"
|
||
|
||
if "${adb_nftcmd}" -t list table inet adblock >/dev/null 2>&1; then
|
||
{
|
||
printf '%s\n' "#!${adb_nftcmd} -f"
|
||
printf '%s\n' "delete table inet adblock"
|
||
} >"${file}"
|
||
|
||
if "${adb_nftcmd}" -f "${file}" 2>>"${adb_errorlog}"; then
|
||
f_log "info" "adblock-related nft rules removed"
|
||
else
|
||
f_log "err" "failed to remove adblock-related nft rules"
|
||
fi
|
||
fi
|
||
}
|
||
|
||
# backup/restore/remove blocklists
|
||
#
|
||
f_list() {
|
||
local file files item array safe_url safe_ips safe_cname safe_domains ip out_rc file_name mode="${1}" src_name="${2:-"${src_name}"}" in_rc="${src_rc:-0}" use_cname="0"
|
||
|
||
case "${mode}" in
|
||
"blocklist" | "allowlist")
|
||
src_name="${mode}"
|
||
case "${src_name}" in
|
||
"blocklist")
|
||
if [ -f "${adb_blocklist}" ]; then
|
||
file_name="${adb_tmpfile}.${src_name}"
|
||
f_chkdom local 1 < "${adb_blocklist}" >"${adb_tmpdir}/tmp.raw.${src_name}"
|
||
if [ -s "${adb_allowlist}" ]; then
|
||
"${adb_awkcmd}" 'NR==FNR{member[$1];next}!($1 in member)' "${adb_allowlist}" "${adb_tmpdir}/tmp.raw.${src_name}" >"${adb_tmpdir}/tmp.deduplicate.${src_name}"
|
||
else
|
||
"${adb_mvcmd}" -f "${adb_tmpdir}/tmp.raw.${src_name}" "${adb_tmpdir}/tmp.deduplicate.${src_name}"
|
||
fi
|
||
if [ "${adb_tld}" = "1" ]; then
|
||
"${adb_awkcmd}" 'BEGIN{FS="."}{for(f=NF;f>1;f--)printf "%s.",$f;print $1}' "${adb_tmpdir}/tmp.deduplicate.${src_name}" |
|
||
"${adb_sortcmd}" ${adb_srtopts} -u >"${file_name}"
|
||
out_rc="${?}"
|
||
else
|
||
"${adb_sortcmd}" ${adb_srtopts} -u "${adb_tmpdir}/tmp.deduplicate.${src_name}" 2>>"${adb_errorlog}" >"${file_name}"
|
||
out_rc="${?}"
|
||
fi
|
||
fi
|
||
;;
|
||
"allowlist")
|
||
if [ -f "${adb_allowlist}" ] && [ "${adb_dnsallow}" = "1" ]; then
|
||
file_name="${adb_tmpdir}/tmp.raw.${src_name}"
|
||
[ "${adb_lookupdomain}" != "localhost" ] && { printf '%s\n' "${adb_lookupdomain}" | f_chkdom local 1; } >"${file_name}"
|
||
f_chkdom local 1 < "${adb_allowlist}" >>"${file_name}"
|
||
f_chkdom local 1 < "${file_name}" >"${adb_tmpdir}/tmp.rem.${src_name}"
|
||
f_dnsallow "${file_name}" >"${adb_tmpdir}/tmp.add.${src_name}"
|
||
out_rc="${?}"
|
||
if [ "${adb_jail}" = "1" ] && [ -n "${adb_dnsstop}" ]; then
|
||
printf '%b' "${adb_dnsheader}" >"${adb_tmpdir}/${adb_dnsfile}"
|
||
"${adb_catcmd}" "${adb_tmpdir}/tmp.add.${src_name}" >>"${adb_tmpdir}/${adb_dnsfile}"
|
||
printf '%b\n' "${adb_dnsstop}" >>"${adb_tmpdir}/${adb_dnsfile}"
|
||
fi
|
||
fi
|
||
;;
|
||
esac
|
||
;;
|
||
"safesearch")
|
||
file_name="${adb_tmpdir}/tmp.safesearch.${src_name}"
|
||
if [ "${adb_dns}" = "named" ] || [ "${adb_dns}" = "kresd" ] || [ "${adb_dns}" = "smartdns" ]; then
|
||
use_cname="1"
|
||
fi
|
||
case "${src_name}" in
|
||
"google")
|
||
safe_url="https://www.google.com/supported_domains"
|
||
safe_cname="forcesafesearch.google.com"
|
||
if [ -s "${adb_backupdir}/safesearch.${src_name}.gz" ]; then
|
||
"${adb_zcatcmd}" "${adb_backupdir}/safesearch.${src_name}.gz" >"${adb_tmpdir}/tmp.load.safesearch.${src_name}"
|
||
else
|
||
"${adb_fetchcmd}" ${adb_fetchparm} "${adb_tmpdir}/tmp.load.safesearch.${src_name}" "${safe_url}" 2>>"${adb_errorlog}"
|
||
if [ -s "${adb_tmpdir}/tmp.load.safesearch.${src_name}" ]; then
|
||
"${adb_gzipcmd}" -cf "${adb_tmpdir}/tmp.load.safesearch.${src_name}" >"${adb_backupdir}/safesearch.${src_name}.gz"
|
||
fi
|
||
fi
|
||
[ -s "${adb_tmpdir}/tmp.load.safesearch.${src_name}" ] && safe_domains="$(f_chkdom google 1 < "${adb_tmpdir}/tmp.load.safesearch.${src_name}")"
|
||
;;
|
||
"bing")
|
||
safe_cname="strict.bing.com"
|
||
safe_domains="www.bing.com"
|
||
;;
|
||
"brave")
|
||
safe_cname="forcesafe.search.brave.com"
|
||
safe_domains="search.brave.com"
|
||
;;
|
||
"duckduckgo")
|
||
safe_cname="safe.duckduckgo.com"
|
||
safe_domains="duckduckgo.com"
|
||
;;
|
||
"pixabay")
|
||
safe_cname="safesearch.pixabay.com"
|
||
safe_domains="pixabay.com"
|
||
;;
|
||
"yandex")
|
||
safe_cname="familysearch.yandex.ru"
|
||
safe_domains="ya.ru yandex.ru yandex.com yandex.com.tr yandex.ua yandex.by yandex.ee yandex.lt yandex.lv yandex.md yandex.uz yandex.tm yandex.tj yandex.az yandex.kz"
|
||
;;
|
||
"youtube")
|
||
safe_cname="restrict.youtube.com"
|
||
safe_domains="www.youtube.com m.youtube.com youtubei.googleapis.com youtube.googleapis.com www.youtube-nocookie.com"
|
||
;;
|
||
esac
|
||
if [ -n "${safe_domains}" ] && [ -n "${safe_cname}" ]; then
|
||
if [ "${use_cname}" = "0" ]; then
|
||
safe_ips="$("${adb_lookupcmd}" "${safe_cname}" 2>>"${adb_errorlog}" | "${adb_awkcmd}" '/^Address[ 0-9]*: /{ORS=" ";print $NF}')"
|
||
fi
|
||
if [ -n "${safe_ips}" ] || [ "${use_cname}" = "1" ]; then
|
||
printf '%s\n' ${safe_domains} >"${adb_tmpdir}/tmp.raw.safesearch.${src_name}"
|
||
[ "${use_cname}" = "1" ] && array="${safe_cname}" || array="${safe_ips}"
|
||
fi
|
||
fi
|
||
if [ -s "${adb_tmpdir}/tmp.raw.safesearch.${src_name}" ]; then
|
||
: >"${file_name}"
|
||
for item in ${array}; do
|
||
if ! f_dnssafesearch "${item}" "${adb_tmpdir}/tmp.raw.safesearch.${src_name}" >>"${file_name}"; then
|
||
: >"${file_name}"
|
||
break
|
||
fi
|
||
done
|
||
: >"${adb_tmpdir}/tmp.raw.safesearch.${src_name}"
|
||
out_rc="0"
|
||
fi
|
||
;;
|
||
"prepare")
|
||
file_name="${src_tmpfile}"
|
||
if [ -s "${src_tmpload}" ]; then
|
||
if [ "${adb_tld}" = "1" ]; then
|
||
f_chkdom ${src_rset} < "${src_tmpload}" |
|
||
"${adb_awkcmd}" 'BEGIN{FS="."}{for(f=NF;f>1;f--)printf "%s.",$f;print $1}' |
|
||
"${adb_sortcmd}" ${adb_srtopts} -u >"${src_tmpfile}" 2>>"${adb_errorlog}"
|
||
else
|
||
f_chkdom ${src_rset} < "${src_tmpload}" |
|
||
"${adb_sortcmd}" ${adb_srtopts} -u >"${src_tmpfile}" 2>>"${adb_errorlog}"
|
||
fi
|
||
out_rc="${?}"
|
||
if [ "${out_rc}" = "0" ] && [ -s "${src_tmpfile}" ]; then
|
||
f_list backup
|
||
elif [ "${adb_action}" != "boot" ] && [ "${adb_action}" != "start" ]; then
|
||
f_log "info" "preparation of '${src_name}' failed, rc: ${src_rc}"
|
||
f_list restore
|
||
out_rc="${?}"
|
||
: >"${src_tmpfile}"
|
||
fi
|
||
else
|
||
f_log "info" "download of '${src_name}' failed, url: ${src_url}, rule: ${src_rset:-"-"}, categories: ${src_cat:-"-"}, rc: ${src_rc}"
|
||
if [ "${adb_action}" != "boot" ] && [ "${adb_action}" != "start" ]; then
|
||
f_list restore
|
||
out_rc="${?}"
|
||
fi
|
||
fi
|
||
;;
|
||
"backup")
|
||
file_name="${src_tmpfile}"
|
||
"${adb_gzipcmd}" -cf "${src_tmpfile}" >"${adb_backupdir}/adb_list.${src_name}.gz"
|
||
out_rc="${?}"
|
||
;;
|
||
"restore")
|
||
file_name="${src_tmpfile}"
|
||
if [ -n "${src_name}" ] && [ -s "${adb_backupdir}/adb_list.${src_name}.gz" ]; then
|
||
"${adb_zcatcmd}" "${adb_backupdir}/adb_list.${src_name}.gz" >"${src_tmpfile}"
|
||
out_rc="${?}"
|
||
elif [ -z "${src_name}" ]; then
|
||
for file in "${adb_backupdir}/adb_list."*.gz; do
|
||
if [ -r "${file}" ]; then
|
||
name="${file##*/}"
|
||
name="${name%.*}"
|
||
"${adb_zcatcmd}" "${file}" >"${adb_tmpfile}.${name}"
|
||
out_rc="${?}"
|
||
[ "${out_rc}" != "0" ] && break
|
||
fi
|
||
done
|
||
else
|
||
out_rc="4"
|
||
fi
|
||
if [ "${adb_action}" != "boot" ] && [ "${adb_action}" != "start" ] && [ "${adb_action}" != "restart" ] &&
|
||
[ "${adb_action}" != "resume" ] && [ -n "${src_name}" ] && [ "${out_rc}" != "0" ]; then
|
||
adb_feed="${adb_feed/${src_name}/}"
|
||
fi
|
||
;;
|
||
"remove")
|
||
"${adb_rmcmd}" "${adb_backupdir}/adb_list.${src_name}.gz" 2>>"${adb_errorlog}"
|
||
out_rc="${?}"
|
||
adb_feed="${adb_feed/${src_name}/}"
|
||
;;
|
||
"merge")
|
||
src_name=""
|
||
file_name="${adb_tmpdir}/${adb_dnsfile}"
|
||
|
||
# remove stale backup files
|
||
#
|
||
files="-maxdepth 1 -type f -name *.gz"
|
||
for file in ${adb_feed}; do
|
||
files="${files} ! -name adb_list.${file}.gz"
|
||
done
|
||
if [ "${adb_safesearch}" = "1" ] && [ "${adb_dnssafesearch}" = "1" ]; then
|
||
files="${files} ! -name safesearch.google.gz"
|
||
fi
|
||
"${adb_findcmd}" "${adb_backupdir}" ${files} -print0 2>>"${adb_errorlog}" | xargs -0r "${adb_rmcmd}" -f
|
||
|
||
# merge files
|
||
#
|
||
for file in "${adb_tmpfile}".*; do
|
||
[ -e "${file}" ] || continue
|
||
"${adb_sortcmd}" ${adb_srtopts} -mu "${adb_tmpfile}".* 2>>"${adb_errorlog}" > "${file_name}"
|
||
out_rc="${?}"
|
||
break
|
||
done
|
||
[ -z "${out_rc}" ] && { : > "${file_name}"; out_rc="4"; }
|
||
"${adb_rmcmd}" -f "${adb_tmpfile}".*
|
||
;;
|
||
"final")
|
||
src_name=""
|
||
file_name="${adb_finaldir}/${adb_dnsfile}"
|
||
"${adb_rmcmd}" -f "${file_name}"
|
||
[ -n "${adb_dnsheader}" ] && printf '%b' "${adb_dnsheader}" >>"${file_name}"
|
||
[ -s "${adb_tmpdir}/tmp.add.allowlist" ] && "${adb_sortcmd}" ${adb_srtopts} -u "${adb_tmpdir}/tmp.add.allowlist" >>"${file_name}"
|
||
[ "${adb_safesearch}" = "1" ] && "${adb_catcmd}" "${adb_tmpdir}/tmp.safesearch."* 2>>"${adb_errorlog}" >>"${file_name}"
|
||
if [ "${adb_dnsdeny}" = "1" ]; then
|
||
f_dnsdeny "${adb_tmpdir}/${adb_dnsfile}" >>"${file_name}"
|
||
else
|
||
"${adb_catcmd}" "${adb_tmpdir}/${adb_dnsfile}" >>"${file_name}"
|
||
fi
|
||
if [ "${adb_dnsshift}" = "1" ] && [ ! -L "${adb_dnsdir}/${adb_dnsfile}" ]; then
|
||
"${adb_lncmd}" -fs "${file_name}" "${adb_dnsdir}/${adb_dnsfile}"
|
||
elif [ "${adb_dnsshift}" = "0" ] && [ -s "${adb_backupdir}/${adb_dnsfile}" ]; then
|
||
"${adb_rmcmd}" -f "${adb_backupdir}/${adb_dnsfile}"
|
||
fi
|
||
out_rc="0"
|
||
;;
|
||
esac
|
||
f_count "${mode}" "${file_name}"
|
||
out_rc="${out_rc:-"${in_rc}"}"
|
||
|
||
f_log "debug" "f_list ::: name: ${src_name:-"-"}, mode: ${mode}, cnt: ${adb_cnt}, in_rc: ${in_rc}, out_rc: ${out_rc}"
|
||
return "${out_rc}"
|
||
}
|
||
|
||
# top level domain compression
|
||
#
|
||
f_tld() {
|
||
local cnt_tld cnt_rem source="${1}" temp_tld="${1}.tld"
|
||
|
||
# reverse domain, get unique tlds and unreverse them back to original form
|
||
#
|
||
if "${adb_awkcmd}" '
|
||
function unreverse(dom, n, seg, out, i) {
|
||
n = split(dom, seg, ".")
|
||
out = seg[n]
|
||
for (i = n-1; i >= 1; i--) out = out "." seg[i]
|
||
return out
|
||
}
|
||
{
|
||
if (NR == 1) { tld = $NF }
|
||
else if (index($NF, tld ".") == 0) { print unreverse(tld); tld = $NF }
|
||
}
|
||
END { if (tld) print unreverse(tld) }
|
||
' "${source}" >"${temp_tld}"; then
|
||
[ "${adb_debug}" = "1" ] && cnt_tld="$(f_count tld "${temp_tld}" "var")"
|
||
|
||
# remove allowlisted domains from tld list if allowlist is enabled and not empty
|
||
#
|
||
if [ -s "${adb_tmpdir}/tmp.rem.allowlist" ]; then
|
||
"${adb_awkcmd}" 'NR==FNR{del[$0];next}!($0 in del)' "${adb_tmpdir}/tmp.rem.allowlist" "${temp_tld}" > "${source}"
|
||
"${adb_rmcmd}" -f "${temp_tld}"
|
||
[ "${adb_debug}" = "1" ] && cnt_rem="$(f_count tld "${source}" "var")"
|
||
else
|
||
"${adb_mvcmd}" -f "${temp_tld}" "${source}"
|
||
fi
|
||
fi
|
||
|
||
f_log "debug" "f_tld ::: name: -, cnt: ${adb_cnt:-"-"}, cnt_tld: ${cnt_tld:-"-"}, cnt_rem: ${cnt_rem:-"-"}"
|
||
}
|
||
|
||
# suspend/resume adblock processing
|
||
#
|
||
f_switch() {
|
||
local status done mode="${1}"
|
||
|
||
json_init
|
||
json_load_file "${adb_rtfile}" >/dev/null 2>&1
|
||
json_select "data" >/dev/null 2>&1
|
||
json_get_var status "adblock_status"
|
||
f_env
|
||
|
||
# suspend adblock processing
|
||
#
|
||
if [ "${status}" = "enabled" ] && [ "${mode}" = "suspend" ]; then
|
||
|
||
# suspend via external DNS bridge
|
||
#
|
||
if { [ -n "${adb_bridgednsv4}" ] || [ -n "${adb_bridgednsv6}" ]; } && [ "${adb_nftbridge}" = "1" ]; then
|
||
if "${adb_nftcmd}" list chain inet adblock dns-bridge >/dev/null 2>&1; then
|
||
if [ -n "${adb_bridgednsv4}" ]; then
|
||
"${adb_nftcmd}" add rule inet adblock dns-bridge meta nfproto ipv4 meta l4proto { udp, tcp } th dport 53 counter dnat to ${adb_bridgednsv4}:53 2>>"${adb_errorlog}"
|
||
done="${?}"
|
||
fi
|
||
if [ -n "${adb_bridgednsv6}" ]; then
|
||
"${adb_nftcmd}" add rule inet adblock dns-bridge meta nfproto ipv6 meta l4proto { udp, tcp } th dport 53 counter dnat to [${adb_bridgednsv6}]:53 2>>"${adb_errorlog}"
|
||
done="$(( done + $? ))"
|
||
fi
|
||
[ "${done}" = "0" ] && done="nft"
|
||
fi
|
||
|
||
# suspend via local DNS
|
||
#
|
||
else
|
||
if [ "${adb_dnsshift}" = "0" ] && [ -f "${adb_finaldir}/${adb_dnsfile}" ]; then
|
||
"${adb_mvcmd}" -f "${adb_finaldir}/${adb_dnsfile}" "${adb_backupdir}/${adb_dnsfile}"
|
||
printf '%b' "${adb_dnsheader}" >"${adb_finaldir}/${adb_dnsfile}"
|
||
done="dns"
|
||
elif [ "${adb_dnsshift}" = "1" ] && [ -L "${adb_dnsdir}/${adb_dnsfile}" ]; then
|
||
"${adb_rmcmd}" -f "${adb_dnsdir}/${adb_dnsfile}"
|
||
printf '%b' "${adb_dnsheader}" >"${adb_dnsdir}/${adb_dnsfile}"
|
||
done="dns"
|
||
fi
|
||
fi
|
||
|
||
# resume adblock processing
|
||
#
|
||
elif [ "${status}" = "paused" ] && [ "${mode}" = "resume" ]; then
|
||
|
||
# resume via external DNS bridge
|
||
#
|
||
if [ "${adb_nftbridge}" = "1" ] && "${adb_nftcmd}" list chain inet adblock dns-bridge >/dev/null 2>&1; then
|
||
if "${adb_nftcmd}" flush chain inet adblock dns-bridge 2>>"${adb_errorlog}"; then
|
||
done="nft"
|
||
fi
|
||
f_count "final" "${adb_finaldir}/${adb_dnsfile}"
|
||
|
||
# resume via local DNS
|
||
#
|
||
else
|
||
if [ "${adb_dnsshift}" = "0" ] && [ -f "${adb_backupdir}/${adb_dnsfile}" ]; then
|
||
"${adb_mvcmd}" -f "${adb_backupdir}/${adb_dnsfile}" "${adb_finaldir}/${adb_dnsfile}"
|
||
f_count "final" "${adb_finaldir}/${adb_dnsfile}"
|
||
done="dns"
|
||
elif [ "${adb_dnsshift}" = "1" ] && [ ! -L "${adb_finaldir}/${adb_dnsfile}" ]; then
|
||
"${adb_lncmd}" -fs "${adb_finaldir}/${adb_dnsfile}" "${adb_dnsdir}/${adb_dnsfile}"
|
||
f_count "final" "${adb_finaldir}/${adb_dnsfile}"
|
||
done="dns"
|
||
fi
|
||
fi
|
||
fi
|
||
|
||
# update runtime information and log action
|
||
#
|
||
if [ "${done}" = "nft" ]; then
|
||
f_jsnup "${mode}"
|
||
f_log "info" "${mode} adblock service via external DNS bridge"
|
||
elif [ "${done}" = "dns" ]; then
|
||
f_dnsup
|
||
f_jsnup "${mode}"
|
||
f_log "info" "${mode} adblock service via local DNS"
|
||
else
|
||
f_count "final" "${adb_finaldir}/${adb_dnsfile}"
|
||
f_jsnup "${status}"
|
||
fi
|
||
f_rmtemp
|
||
}
|
||
|
||
# search blocklist for certain (sub-)domains
|
||
#
|
||
f_search() {
|
||
local rc search res result tmp_result prefix suffix field search_start search_end search_timeout=30 domain="${1}" tld="${1#*.}"
|
||
|
||
# prepare result file
|
||
#
|
||
tmp_result="/var/run/adblock.search.tmp"
|
||
result="/var/run/adblock.search"
|
||
|
||
# input validation
|
||
#
|
||
case "${domain}" in
|
||
""|*[!a-zA-Z0-9.-]*|-*|*-|*..*|*.)
|
||
printf '%s\n' "::: invalid input, please submit a single (sub-)domain :::"
|
||
printf '%s\n' "::: invalid input, please submit a single (sub-)domain :::" >"${result}"
|
||
return
|
||
;;
|
||
esac
|
||
|
||
# length validation for domain part, max. 253 characters according to RFC 1035
|
||
#
|
||
case "${#domain}" in
|
||
[0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-3])
|
||
;;
|
||
*)
|
||
printf '%s\n' "::: invalid input, domain exceeds 253 characters :::"
|
||
printf '%s\n' "::: invalid input, domain exceeds 253 characters :::" >"${result}"
|
||
return
|
||
;;
|
||
esac
|
||
|
||
# search blocklist
|
||
#
|
||
case "${adb_dns}" in
|
||
"dnsmasq")
|
||
prefix='local=.*[\/\.]'
|
||
suffix='\/'
|
||
field="2"
|
||
;;
|
||
"unbound")
|
||
prefix='local-zone: .*["\.]'
|
||
suffix='" always_nxdomain'
|
||
field="3"
|
||
;;
|
||
"named")
|
||
prefix=""
|
||
suffix=' CNAME \.'
|
||
field="1"
|
||
;;
|
||
"kresd")
|
||
prefix=""
|
||
suffix=' CNAME \.'
|
||
field="1"
|
||
;;
|
||
"smartdns")
|
||
prefix='address .*.*[\/\.]'
|
||
suffix='\/#'
|
||
field="3"
|
||
;;
|
||
"raw")
|
||
prefix=""
|
||
suffix=""
|
||
field="1"
|
||
;;
|
||
esac
|
||
|
||
# initialize tmp_result and start search
|
||
#
|
||
: >"${tmp_result}"
|
||
read -r search_start _ < "/proc/uptime"
|
||
search_start="${search_start%.*}"
|
||
|
||
# search recursively for domain and its parent domains until tld is reached
|
||
#
|
||
while :; do
|
||
search="${domain//./\\.}"
|
||
res="$("${adb_awkcmd}" -F '/|\"|\t| ' "/^(${prefix}${search}${suffix})$/{i++;if(i<=9){printf \" + %s\n\",\$${field}}else if(i==10){printf \" + %s\n\",\"[...]\";exit}}" "${adb_finaldir}/${adb_dnsfile}")"
|
||
printf '%s\n%s\n%s\n' ":::" "::: domain '${domain}' in active blocklist" ":::" >>"${tmp_result}"
|
||
printf '%s\n\n' "${res:-" - no match"}" >>"${tmp_result}"
|
||
[ "${domain}" = "${tld}" ] && break
|
||
domain="${tld}"
|
||
tld="${domain#*.}"
|
||
done
|
||
|
||
# search exactly for domain in backup files and local block-/allowlist
|
||
#
|
||
if [ -d "${adb_backupdir}" ]; then
|
||
search="${1//./\\.}"
|
||
printf '%s\n%s\n%s\n' ":::" "::: domain '${1}' in backups and in local block-/allowlist" ":::" >>"${tmp_result}"
|
||
for file in "${adb_backupdir}/adb_list".*.gz "${adb_blocklist}" "${adb_allowlist}"; do
|
||
suffix="${file##*.}"
|
||
if [ "${suffix}" = "gz" ]; then
|
||
if [ "${adb_tld}" = "1" ]; then
|
||
"${adb_zcatcmd}" "${file}" 2>>"${adb_errorlog}" |
|
||
"${adb_awkcmd}" 'BEGIN{FS="."}{for(f=NF;f>1;f--)printf "%s.",$f;print $1}' |
|
||
"${adb_awkcmd}" -v f="${file##*/}" "BEGIN{rc=1};/^($search|.*\\.${search})$/{i++;if(i<=3){printf \" + %-30s%s\n\",f,\$1;rc=0}else if(i==4){printf \" + %-30s%s\n\",f,\"[...]\"}};END{exit rc}" >>"${tmp_result}"
|
||
else
|
||
"${adb_zcatcmd}" "${file}" 2>>"${adb_errorlog}" |
|
||
"${adb_awkcmd}" -v f="${file##*/}" "BEGIN{rc=1};/^($search|.*\\.${search})$/{i++;if(i<=3){printf \" + %-30s%s\n\",f,\$1;rc=0}else if(i==4){printf \" + %-30s%s\n\",f,\"[...]\"}};END{exit rc}" >>"${tmp_result}"
|
||
fi
|
||
rc="${?}"
|
||
else
|
||
"${adb_awkcmd}" -v f="${file##*/}" "BEGIN{rc=1};/^($search|.*\\.${search})$/{i++;if(i<=3){printf \" + %-30s%s\n\",f,\$1;rc=0}else if(i==4){printf \" + %-30s%s\n\",f,\"[...]\"}};END{exit rc}" "${file}" >>"${tmp_result}"
|
||
rc="${?}"
|
||
fi
|
||
if [ "${rc}" = "0" ]; then
|
||
res="true"
|
||
read -r search_end _ < "/proc/uptime"
|
||
search_end="${search_end%.*}"
|
||
if [ "$((search_end - search_start))" -gt "${search_timeout}" ]; then
|
||
printf '%s\n\n' " - [...]" >>"${tmp_result}"
|
||
break
|
||
fi
|
||
fi
|
||
done
|
||
[ "${res}" != "true" ] && printf '%s\n\n' " - no match" >>"${tmp_result}"
|
||
fi
|
||
"${adb_mvcmd}" -f "${tmp_result}" "${result}"
|
||
"${adb_catcmd}" "${result}" 2>>"${adb_errorlog}"
|
||
}
|
||
|
||
# update runtime information
|
||
#
|
||
f_jsnup() {
|
||
local pids object feeds end_time runtime dns dns_ver dns_mem free_mem custom_feed="0" status="${1:-"enabled"}"
|
||
local duration jail="0" nft_unfiltered="0" nft_filtered="0" nft_remote="0" nft_bridge="0" nft_force="0"
|
||
|
||
# get DNS memory usage and version
|
||
#
|
||
if adb_dnspid="$("${adb_ubuscmd}" -S call service list 2>>"${adb_errorlog}" | \
|
||
"${adb_jsoncmd}" -l1 -e "@[\"${adb_dns}\"].instances.*.pid")" && [ -n "${adb_dnspid}" ]; then
|
||
pids="$("${adb_pgrepcmd}" -P "${adb_dnspid}" 2>>"${adb_errorlog}")"
|
||
for pid in ${adb_dnspid} ${pids}; do
|
||
dns_mem="$((dns_mem + $("${adb_awkcmd}" '/^VmSize/{printf "%s", $2}' "/proc/${pid}/status" 2>>"${adb_errorlog}")))"
|
||
done
|
||
case "${adb_dns}" in
|
||
"kresd")
|
||
dns="knot-resolver"
|
||
;;
|
||
"named")
|
||
dns="bind-server"
|
||
;;
|
||
"unbound")
|
||
dns="unbound-daemon"
|
||
;;
|
||
"dnsmasq")
|
||
dns='dnsmasq", "dnsmasq-full", "dnsmasq-dhcpv6'
|
||
;;
|
||
esac
|
||
dns_ver="$(printf '%s' "${adb_packages}" | "${adb_jsoncmd}" -ql1 -e "@.packages[\"${dns:-"${adb_dns}"}\"]")"
|
||
dns_mem="$("${adb_awkcmd}" -v mem="${dns_mem}" 'BEGIN{printf "%.2f", mem/1024}' 2>>"${adb_errorlog}")"
|
||
fi
|
||
free_mem="$("${adb_awkcmd}" '/^MemAvailable/{printf "%.2f", $2/1024}' "/proc/meminfo" 2>>"${adb_errorlog}")"
|
||
adb_cnt="$("${adb_awkcmd}" -v cnt="${adb_cnt}" 'BEGIN{res="";pos=0;for(i=length(cnt);i>0;i--){res=substr(cnt,i,1)res;pos++;if(pos==3&&i>1){res=" "res;pos=0;}}; printf"%s",res}')"
|
||
|
||
# check for custom feed and nft rules
|
||
#
|
||
[ -s "${adb_customfeedfile}" ] && custom_feed="1"
|
||
if [ "${adb_nftforce}" = "1" ] && [ -n "${adb_nftdevforce}" ] && [ -n "${adb_nftportforce}" ]; then
|
||
nft_force="1"
|
||
fi
|
||
if [ "${adb_nftallow}" = "1" ] \
|
||
&& { [ -n "${adb_nftmacallow}" ] || [ -n "${adb_nftdevallow}" ]; } \
|
||
&& { [ -n "${adb_allowdnsv4}" ] || [ -n "${adb_allowdnsv6}" ]; }; then
|
||
nft_unfiltered="1"
|
||
fi
|
||
if [ "${adb_nftblock}" = "1" ] \
|
||
&& { [ -n "${adb_nftmacblock}" ] || [ -n "${adb_nftdevblock}" ]; } \
|
||
&& { [ -n "${adb_blockdnsv4}" ] || [ -n "${adb_blockdnsv6}" ]; }; then
|
||
nft_filtered="1"
|
||
fi
|
||
if [ "${adb_nftremote}" = "1" ] && [ -n "${adb_nftmacremote}" ] \
|
||
&& { [ -n "${adb_remotednsv4}" ] || [ -n "${adb_remotednsv6}" ]; }; then
|
||
nft_remote="1"
|
||
fi
|
||
if [ "${adb_nftbridge}" = "1" ] \
|
||
&& { [ -n "${adb_bridgednsv4}" ] || [ -n "${adb_bridgednsv6}" ]; }; then
|
||
nft_bridge="1"
|
||
fi
|
||
|
||
# update runtime information based on status
|
||
#
|
||
case "${status}" in
|
||
"enabled")
|
||
if [ -n "${adb_starttime}" ]; then
|
||
read -r end_time _ < "/proc/uptime"
|
||
end_time="${end_time%.*}"
|
||
duration="$(((end_time - adb_starttime) / 60))m $(((end_time - adb_starttime) % 60))s"
|
||
fi
|
||
runtime="mode: ${adb_action}, date / time: $(date "+%d/%m/%Y %H:%M:%S"), duration: ${duration:-"-"}, memory: ${free_mem:-0} MB available"
|
||
;;
|
||
"resume")
|
||
status="enabled"
|
||
;;
|
||
"suspend")
|
||
adb_cnt="0"
|
||
status="paused"
|
||
;;
|
||
*)
|
||
adb_cnt="0"
|
||
;;
|
||
esac
|
||
|
||
# update runtime file and send mail if enabled
|
||
#
|
||
json_init
|
||
if json_load_file "${adb_rtfile}" >/dev/null 2>&1; then
|
||
[ -z "${adb_cnt}" ] && json_get_var adb_cnt "blocked_domains"
|
||
[ -z "${runtime}" ] && json_get_var runtime "last_run"
|
||
if [ "${status}" = "enabled" ]; then
|
||
if [ "${adb_jail}" = "1" ] && [ -n "${adb_dnsstop}" ]; then
|
||
jail="1"
|
||
adb_cnt="0"
|
||
feeds="restrictive jail (allowlist-only)"
|
||
else
|
||
feeds="$(printf '%s\n' ${adb_feed// /, } | ${adb_sortcmd} | xargs)"
|
||
fi
|
||
fi
|
||
fi
|
||
printf '%s\n' "{}" >"${adb_rtfile}"
|
||
json_init
|
||
json_load_file "${adb_rtfile}" >/dev/null 2>&1
|
||
json_add_string "adblock_status" "${status}"
|
||
json_add_string "frontend_ver" "${adb_fver}"
|
||
json_add_string "backend_ver" "${adb_bver}"
|
||
json_add_string "blocked_domains" "${adb_cnt:-"0"}"
|
||
json_add_array "active_feeds"
|
||
for object in ${feeds:-"-"}; do
|
||
json_add_string "${object}" "${object}"
|
||
done
|
||
json_close_array
|
||
json_add_string "dns_backend" "${adb_dns:-"-"} (${dns_ver:-"-"}), ${adb_finaldir:-"-"}, ${dns_mem:-"0"} MB"
|
||
json_add_string "run_ifaces" "trigger: ${adb_trigger:-"-"}, report: ${adb_repiface:-"-"}"
|
||
json_add_string "run_information" "base: ${adb_basedir}, dns: ${adb_dnsdir}, backup: ${adb_backupdir}, report: ${adb_reportdir}, error: ${adb_errorlog}"
|
||
json_add_string "run_flags" "shift: $(f_char ${adb_dnsshift}), custom feed: $(f_char ${custom_feed}), ext. DNS (std/prot/remote/bridge): $(f_char ${nft_unfiltered})/$(f_char ${nft_filtered})/$(f_char ${nft_remote})/$(f_char ${nft_bridge}), force: $(f_char ${nft_force}), flush: $(f_char ${adb_dnsflush}), tld: $(f_char ${adb_tld}), search: $(f_char ${adb_safesearch}), report: $(f_char ${adb_report}), mail: $(f_char ${adb_mail}), jail: $(f_char ${jail}), debug: $(f_char ${adb_debug})"
|
||
json_add_string "last_run" "${runtime:-"-"}"
|
||
json_add_string "system_info" "cores: ${adb_cores}, fetch: ${adb_fetchcmd##*/}, ${adb_sysver}"
|
||
json_dump >"${adb_rtfile}"
|
||
|
||
if [ "${adb_mail}" = "1" ] && [ -x "${adb_mailservice}" ] && [ "${status}" = "enabled" ]; then
|
||
"${adb_mailservice}" >/dev/null 2>&1
|
||
fi
|
||
}
|
||
|
||
# write to syslog
|
||
#
|
||
f_log() {
|
||
local class="${1}" log_msg="${2}"
|
||
|
||
if [ -n "${log_msg}" ] && { [ "${class}" != "debug" ] || [ "${adb_debug}" = "1" ]; }; then
|
||
[ -x "${adb_loggercmd}" ] && "${adb_loggercmd}" -p "${class}" -t "adblock-${adb_bver}[${$}]" "${log_msg::256}" ||
|
||
printf '%s %s %s\n' "${class}" "adblock-${adb_bver}[${$}]" "${log_msg::256}"
|
||
if [ "${class}" = "err" ] || [ "${class}" = "emerg" ]; then
|
||
[ "${adb_action}" != "mail" ] && f_rmdns
|
||
f_jsnup "error"
|
||
exit 1
|
||
fi
|
||
fi
|
||
}
|
||
|
||
# main function for blocklist processing
|
||
#
|
||
f_main() {
|
||
local src_tmpload src_tmpfile src_name src_domain src_rset src_url src_cat src_item src_list src_entries src_suffix src_rc entry cnt
|
||
|
||
# allow- and blocklist preparation
|
||
#
|
||
cnt="1"
|
||
for entry in ${adb_locallist}; do
|
||
(
|
||
f_list "${entry}" "${entry}"
|
||
) &
|
||
[ "${cnt}" -gt "${adb_cores}" ] && wait -n
|
||
cnt="$((cnt + 1))"
|
||
done
|
||
wait
|
||
|
||
# jail mode preparation
|
||
#
|
||
if [ "${adb_jail}" = "1" ] && [ -n "${adb_dnsstop}" ]; then
|
||
"${adb_mvcmd}" -f "${adb_tmpdir}/${adb_dnsfile}" "${adb_finaldir}/${adb_dnsfile}"
|
||
chown "${adb_dnsuser}" "${adb_finaldir}/${adb_dnsfile}" 2>>"${adb_errorlog}"
|
||
if [ "${adb_dnsshift}" = "1" ] && [ ! -L "${adb_dnsdir}/${adb_dnsfile}" ]; then
|
||
"${adb_lncmd}" -fs "${adb_finaldir}/${adb_dnsfile}" "${adb_dnsdir}/${adb_dnsfile}"
|
||
elif [ "${adb_dnsshift}" = "0" ] && [ -s "${adb_backupdir}/${adb_dnsfile}" ]; then
|
||
"${adb_rmcmd}" -f "${adb_backupdir}/${adb_dnsfile}"
|
||
fi
|
||
if f_dnsup; then
|
||
if [ "${adb_action}" != "resume" ]; then
|
||
f_jsnup "enabled"
|
||
fi
|
||
f_log "info" "restrictive jail mode enabled successfully (${adb_sysver})"
|
||
else
|
||
f_log "err" "dns backend restart in jail mode failed"
|
||
fi
|
||
f_rmtemp
|
||
return
|
||
fi
|
||
|
||
# safe search preparation
|
||
#
|
||
if [ "${adb_safesearch}" = "1" ] && [ "${adb_dnssafesearch}" = "1" ]; then
|
||
[ -z "${adb_safesearchlist}" ] && adb_safesearchlist="google bing brave duckduckgo pixabay yandex youtube"
|
||
cnt="1"
|
||
for entry in ${adb_safesearchlist}; do
|
||
(
|
||
f_list safesearch "${entry}"
|
||
) &
|
||
[ "${cnt}" -gt "${adb_cores}" ] && wait -n
|
||
cnt="$((cnt + 1))"
|
||
done
|
||
wait
|
||
fi
|
||
|
||
# main loop
|
||
#
|
||
cnt="1"
|
||
: >"${adb_tmpdir}/tmp.raw.allowlist"
|
||
for src_name in ${adb_feed}; do
|
||
if ! json_select "${src_name}" >/dev/null 2>&1; then
|
||
adb_feed="${adb_feed/${src_name}/}"
|
||
continue
|
||
fi
|
||
|
||
# get feed information
|
||
#
|
||
json_get_var src_url "url" >/dev/null 2>&1
|
||
json_get_var src_rset "rule" >/dev/null 2>&1
|
||
json_select ..
|
||
src_tmpcat="${adb_tmpload}.${src_name}.cat"
|
||
src_tmpload="${adb_tmpload}.${src_name}.load"
|
||
src_tmparchive="${adb_tmpload}.${src_name}.archive"
|
||
src_tmpfile="${adb_tmpfile}.${src_name}"
|
||
src_rc=4
|
||
|
||
# basic pre-checks
|
||
#
|
||
if [ -z "${src_url}" ] || [ -z "${src_rset}" ] ||
|
||
[ "${src_rset%% *}" != "feed" ]; then
|
||
f_list remove
|
||
continue
|
||
fi
|
||
|
||
# add domains of active feed URLs to the allowlist
|
||
#
|
||
src_domain="${src_url#*://}"
|
||
src_domain="${src_domain%%/*}"
|
||
if [ -n "${src_domain}" ] && [ "${adb_dnsallow}" = "1" ] && ! "${adb_grepcmd}" -qxF "${src_domain}" "${adb_tmpdir}/tmp.raw.allowlist"; then
|
||
printf '%s\n' "${src_domain}" >>"${adb_tmpdir}/tmp.raw.allowlist"
|
||
printf '%s\n' "${src_domain}" | f_dnsallow >>"${adb_tmpdir}/tmp.add.allowlist"
|
||
fi
|
||
|
||
# download queue processing
|
||
#
|
||
src_cat=""
|
||
src_entries=""
|
||
[ "${src_name}" = "1hosts" ] && src_cat="${adb_hst_feed}"
|
||
[ "${src_name}" = "hagezi" ] && src_cat="${adb_hag_feed}"
|
||
[ "${src_name}" = "ipfire_dbl" ] && src_cat="${adb_ipf_feed}"
|
||
[ "${src_name}" = "stevenblack" ] && src_cat="${adb_stb_feed}"
|
||
|
||
# category handling for feeds with multiple categories
|
||
#
|
||
if [ -n "${src_cat}" ]; then
|
||
(
|
||
# restore handling on boot, resume or (re-)start
|
||
#
|
||
if [ "${adb_action}" = "boot" ] || [ "${adb_action}" = "start" ] || [ "${adb_action}" = "restart" ] || [ "${adb_action}" = "resume" ]; then
|
||
if f_list restore && [ -s "${src_tmpfile}" ]; then
|
||
exit 0
|
||
fi
|
||
fi
|
||
|
||
# etag handling on reload
|
||
#
|
||
if [ -n "${adb_etagparm}" ] && [ "${adb_action}" = "reload" ]; then
|
||
etag_rc="0"
|
||
src_cnt="0"
|
||
for _ in ${src_cat}; do
|
||
src_cnt="$((src_cnt + 1))"
|
||
done
|
||
for suffix in ${src_cat}; do
|
||
if ! f_etag "${src_name}" "${src_url}" "${suffix}" "${src_cnt}"; then
|
||
etag_rc="$((etag_rc + 1))"
|
||
fi
|
||
done
|
||
if [ "${etag_rc}" = "0" ]; then
|
||
if f_list restore && [ -s "${src_tmpfile}" ]; then
|
||
exit 0
|
||
fi
|
||
fi
|
||
fi
|
||
|
||
# category download
|
||
#
|
||
for suffix in ${src_cat}; do
|
||
"${adb_fetchcmd}" ${adb_fetchparm} "${src_tmpcat}" "${src_url}${suffix}" 2>>"${adb_errorlog}"
|
||
src_rc="${?}"
|
||
if [ "${src_rc}" = "0" ] && [ -s "${src_tmpcat}" ]; then
|
||
"${adb_catcmd}" "${src_tmpcat}" >>"${src_tmpload}"
|
||
: >"${src_tmpcat}"
|
||
fi
|
||
done
|
||
f_list prepare
|
||
) &
|
||
|
||
# normal handling for feeds without categories
|
||
#
|
||
else
|
||
(
|
||
[ "${src_name}" = "utcapitole" ] && src_cat="${adb_utc_feed}"
|
||
|
||
# restore handling on boot, resume or (re-)start
|
||
#
|
||
if [ "${adb_action}" = "boot" ] || [ "${adb_action}" = "start" ] || [ "${adb_action}" = "restart" ] || [ "${adb_action}" = "resume" ]; then
|
||
if f_list restore && [ -s "${src_tmpfile}" ]; then
|
||
exit 0
|
||
fi
|
||
fi
|
||
|
||
# etag handling on reload
|
||
#
|
||
if [ -n "${adb_etagparm}" ] && [ "${adb_action}" = "reload" ]; then
|
||
if f_etag "${src_name}" "${src_url}"; then
|
||
if f_list restore && [ -s "${src_tmpfile}" ]; then
|
||
exit 0
|
||
fi
|
||
fi
|
||
fi
|
||
|
||
# download feed and extract categories if necessary
|
||
#
|
||
if [ "${src_name}" = "utcapitole" ]; then
|
||
if [ -n "${src_cat}" ]; then
|
||
"${adb_fetchcmd}" ${adb_fetchparm} "${src_tmparchive}" "${src_url}" 2>>"${adb_errorlog}"
|
||
src_rc="${?}"
|
||
if [ "${src_rc}" = "0" ] && [ -s "${src_tmparchive}" ]; then
|
||
src_suffix="${adb_src_suffix_utcapitole:-"domains"}"
|
||
src_list="$(tar -tzf "${src_tmparchive}" 2>>"${adb_errorlog}")"
|
||
for src_item in ${src_cat}; do
|
||
src_entries="${src_entries} $(printf '%s' "${src_list}" | "${adb_grepcmd}" -E "${src_item}/${src_suffix}$")"
|
||
done
|
||
if [ -n "${src_entries}" ]; then
|
||
tar -xOzf "${src_tmparchive}" ${src_entries} 2>>"${adb_errorlog}" >"${src_tmpload}"
|
||
src_rc="${?}"
|
||
fi
|
||
: >"${src_tmparchive}"
|
||
fi
|
||
fi
|
||
else
|
||
"${adb_fetchcmd}" ${adb_fetchparm} "${src_tmpload}" "${src_url}" 2>>"${adb_errorlog}"
|
||
src_rc="${?}"
|
||
fi
|
||
f_list prepare
|
||
) &
|
||
fi
|
||
[ "${cnt}" -gt "${adb_cores}" ] && wait -n
|
||
cnt="$((cnt + 1))"
|
||
done
|
||
wait
|
||
|
||
# tld compression and dns restart
|
||
#
|
||
if f_list merge && [ -s "${adb_tmpdir}/${adb_dnsfile}" ]; then
|
||
[ "${adb_tld}" = "1" ] && f_tld "${adb_tmpdir}/${adb_dnsfile}"
|
||
f_list final
|
||
else
|
||
printf '%b' "${adb_dnsheader}" >"${adb_finaldir}/${adb_dnsfile}"
|
||
f_log "info" "no merge input, only header written to ${adb_finaldir}/${adb_dnsfile}"
|
||
fi
|
||
chown "${adb_dnsuser}" "${adb_finaldir}/${adb_dnsfile}" 2>>"${adb_errorlog}"
|
||
if f_dnsup; then
|
||
[ "${adb_action}" != "resume" ] && f_jsnup "enabled"
|
||
f_log "info" "blocklist with overall ${adb_cnt} blocked domains loaded successfully (${adb_sysver})"
|
||
else
|
||
f_log "err" "dns backend restart with adblock blocklist failed"
|
||
fi
|
||
f_rmtemp
|
||
}
|
||
|
||
# trace dns queries via tcpdump and prepare a report
|
||
#
|
||
f_report() {
|
||
local report_raw report_txt content status total start end start_date start_time end_date end_time blocked percent top_list top array item index value key key_list
|
||
local ip request requests iface_v4 iface_v6 ip_v4 ip_v6 map_jsn cnt resolve="-nn" action="${1}" top_count="${2:-"10"}" res_count="${3:-"50"}" search="${4:-"+"}"
|
||
|
||
report_raw="${adb_reportdir}/adb_report.raw"
|
||
report_srt="${adb_reportdir}/adb_report.srt"
|
||
report_jsn="${adb_reportdir}/adb_report.jsn"
|
||
report_txt="${adb_reportdir}/adb_mailreport.txt"
|
||
top_tmpclients="${adb_reportdir}/top_clients.tmp"
|
||
top_tmpdomains="${adb_reportdir}/top_domains.tmp"
|
||
top_tmpblocked="${adb_reportdir}/top_blocked.tmp"
|
||
map_jsn="${adb_reportdir}/adb_map.jsn"
|
||
|
||
# build report
|
||
#
|
||
if [ "${action}" != "json" ]; then
|
||
: >"${report_srt}" >"${report_txt}" >"${report_jsn}" >"${map_jsn}"
|
||
: >"${top_tmpclients}" >"${top_tmpdomains}" >"${top_tmpblocked}"
|
||
[ "${adb_represolve}" = "1" ] && resolve=""
|
||
cnt="1"
|
||
for file in "${adb_reportdir}/adb_report.pcap"*; do
|
||
[ -s "${file}" ] || continue
|
||
(
|
||
"${adb_dumpcmd}" ${resolve} --immediate-mode -tttt -T domain -r "${file}" 2>/dev/null |
|
||
"${adb_awkcmd}" -v repiface="${adb_repiface}" '
|
||
BEGIN {
|
||
pending = 0
|
||
}
|
||
# ignore Reverse DNS
|
||
/\.in-addr\.arpa/ || /\.ip6\.arpa/ { next }
|
||
# domain request parser (with optional EDNS marker support)
|
||
/\+[[:space:]]+(\[[0-9a-z]*\][[:space:]]+)?(A\?|AAAA\?)/ {
|
||
# drop unresolved previous query
|
||
if (pending)
|
||
pending = 0
|
||
date = $1
|
||
split($2, t, ":")
|
||
time = t[1] ":" t[2] ":" substr(t[3],1,2)
|
||
interface = repiface
|
||
client = $4
|
||
if (repiface == "any") {
|
||
interface = $3
|
||
client = $6
|
||
}
|
||
sub(/\.[0-9]+$/, "", client)
|
||
domain = $(NF-1)
|
||
sub(/[,\.]+$/, "", domain)
|
||
if (domain ~ /\.lan$/) next
|
||
if (domain !~ /\./) next
|
||
if (domain ~ /[\/:]/) next
|
||
qtype = $(NF-2)
|
||
sub(/\?$/, "", qtype)
|
||
last_date = date
|
||
last_time = time
|
||
last_client = client
|
||
last_interface = interface
|
||
last_domain = domain
|
||
last_qtype = qtype
|
||
pending = 1
|
||
next
|
||
}
|
||
# ok answer
|
||
/ (A|AAAA|CNAME) / && !/NXDomain/ && !/ServFail/ {
|
||
if (pending) {
|
||
printf "%s\t%s\t%s\t%s\t%s\t%s\tOK\n",
|
||
last_date, last_time, last_client, last_interface, last_qtype, last_domain
|
||
pending = 0
|
||
}
|
||
next
|
||
}
|
||
# nxdomain answer
|
||
/ NXDomain/ {
|
||
if (pending) {
|
||
printf "%s\t%s\t%s\t%s\t%s\t%s\tNX\n",
|
||
last_date, last_time, last_client, last_interface, last_qtype, last_domain
|
||
pending = 0
|
||
}
|
||
next
|
||
}
|
||
# servfail answer
|
||
/ ServFail/ {
|
||
if (pending) {
|
||
printf "%s\t%s\t%s\t%s\t%s\t%s\tSF\n",
|
||
last_date, last_time, last_client, last_interface, last_qtype, last_domain
|
||
pending = 0
|
||
}
|
||
next
|
||
}
|
||
END {
|
||
# no fallback
|
||
}
|
||
' > "${report_raw}.${cnt}"
|
||
) &
|
||
[ "${cnt}" -gt "${adb_cores}" ] && wait -n
|
||
cnt="$((cnt + 1))"
|
||
done
|
||
wait
|
||
for file in "${report_raw}".*; do
|
||
[ -s "${file}" ] || continue
|
||
"${adb_sortcmd}" ${adb_srtopts} -ru "${report_raw}".* > "${report_srt}"
|
||
"${adb_rmcmd}" -f "${report_raw}".*
|
||
break
|
||
done
|
||
|
||
# build json
|
||
#
|
||
if [ -s "${report_srt}" ]; then
|
||
start="$("${adb_awkcmd}" 'END{printf "%s_%s",$1,$2}' "${report_srt}")"
|
||
end="$("${adb_awkcmd}" 'NR==1{printf "%s_%s",$1,$2}' "${report_srt}")"
|
||
total="$(f_count tld "${report_srt}" "var")"
|
||
blocked="$("${adb_awkcmd}" '{if($7=="NX")cnt++}END{printf "%s",cnt}' "${report_srt}")"
|
||
percent="$("${adb_awkcmd}" -v t="${total}" -v b="${blocked}" 'BEGIN{ if(t>0) printf "%.2f%s",b/t*100,"%"; else printf "0.00%%"}')"
|
||
{
|
||
printf '%s\n' "{ "
|
||
printf '\t%s\n' "\"start_date\": \"${start%_*}\", "
|
||
printf '\t%s\n' "\"start_time\": \"${start#*_}\", "
|
||
printf '\t%s\n' "\"end_date\": \"${end%_*}\", "
|
||
printf '\t%s\n' "\"end_time\": \"${end#*_}\", "
|
||
printf '\t%s\n' "\"total\": \"${total}\", "
|
||
printf '\t%s\n' "\"blocked\": \"${blocked}\", "
|
||
printf '\t%s\n' "\"percent\": \"${percent}\", "
|
||
} >"${report_jsn}"
|
||
|
||
# build top list counters
|
||
#
|
||
"${adb_awkcmd}" '
|
||
{
|
||
if (NF < 7) {
|
||
next
|
||
}
|
||
client = $3
|
||
domain = $6
|
||
rc = $7
|
||
|
||
if (domain == "" || domain == "-") {
|
||
next
|
||
}
|
||
|
||
sub(/[\.]+$/, "", domain)
|
||
domain = tolower(domain)
|
||
|
||
clients[client]++
|
||
if (rc == "OK") {
|
||
ok_domain[domain]++
|
||
}
|
||
else if (rc == "NX") {
|
||
nx_domain[domain]++
|
||
}
|
||
all_domain[domain]++
|
||
}
|
||
END {
|
||
for (c in clients) {
|
||
printf "%d %s\n", clients[c], c > "'"${top_tmpclients}"'"
|
||
}
|
||
for (d in all_domain) {
|
||
if (d in ok_domain) {
|
||
printf "%d %s\n", ok_domain[d], d > "'"${top_tmpdomains}"'"
|
||
}
|
||
if (d in nx_domain) {
|
||
printf "%d %s\n", nx_domain[d], d > "'"${top_tmpblocked}"'"
|
||
}
|
||
}
|
||
}
|
||
' "${report_srt}"
|
||
|
||
# build json top lists
|
||
#
|
||
top_list="top_clients top_domains top_blocked"
|
||
for top in ${top_list}; do
|
||
printf '\t"%s": [ ' "${top}" >>"${report_jsn}"
|
||
case "${top}" in
|
||
top_clients)
|
||
"${adb_sortcmd}" ${adb_srtopts} -nr "${top_tmpclients}" |
|
||
"${adb_awkcmd}" -v top_count="${top_count}" '
|
||
BEGIN { ORS=""; OFS="" }
|
||
NR==1 {
|
||
printf "\n\t\t{\n\t\t\t\"count\": \"%s\",\n\t\t\t\"address\": \"%s\"\n\t\t}", $1, $2
|
||
}
|
||
NR>1 && NR<=top_count {
|
||
printf ",\n\t\t{\n\t\t\t\"count\": \"%s\",\n\t\t\t\"address\": \"%s\"\n\t\t}", $1, $2
|
||
}
|
||
' >>"${report_jsn}"
|
||
;;
|
||
top_domains)
|
||
"${adb_sortcmd}" ${adb_srtopts} -nr "${top_tmpdomains}" |
|
||
"${adb_awkcmd}" -v top_count="${top_count}" '
|
||
BEGIN { ORS=""; OFS="" }
|
||
NR==1 {
|
||
printf "\n\t\t{\n\t\t\t\"count\": \"%s\",\n\t\t\t\"address\": \"%s\"\n\t\t}", $1, $2
|
||
}
|
||
NR>1 && NR<=top_count {
|
||
printf ",\n\t\t{\n\t\t\t\"count\": \"%s\",\n\t\t\t\"address\": \"%s\"\n\t\t}", $1, $2
|
||
}
|
||
' >>"${report_jsn}"
|
||
;;
|
||
top_blocked)
|
||
"${adb_sortcmd}" ${adb_srtopts} -nr "${top_tmpblocked}" |
|
||
"${adb_awkcmd}" -v top_count="${top_count}" '
|
||
BEGIN { ORS=""; OFS="" }
|
||
NR==1 {
|
||
printf "\n\t\t{\n\t\t\t\"count\": \"%s\",\n\t\t\t\"address\": \"%s\"\n\t\t}", $1, $2
|
||
}
|
||
NR>1 && NR<=top_count {
|
||
printf ",\n\t\t{\n\t\t\t\"count\": \"%s\",\n\t\t\t\"address\": \"%s\"\n\t\t}", $1, $2
|
||
}
|
||
' >>"${report_jsn}"
|
||
;;
|
||
esac
|
||
printf '\n\t],\n' >>"${report_jsn}"
|
||
done
|
||
"${adb_rmcmd}" -f "${top_tmpclients}" "${top_tmpdomains}" "${top_tmpblocked}"
|
||
|
||
# build json request list
|
||
#
|
||
search="${search//[+*~%\$&\"\' ]/}"
|
||
case "${res_count}" in
|
||
''|*[!0-9]* )
|
||
res_count="50"
|
||
;;
|
||
esac
|
||
"${adb_awkcmd}" -v search="${search}" -v res_count="${res_count}" '
|
||
BEGIN {
|
||
i = 0
|
||
printf "\t\"requests\": [\n"
|
||
}
|
||
|
||
# only match if search is empty or non-empty and NF == 7
|
||
((search == "" || index($0, search)) && NF == 7) {
|
||
i++
|
||
if (res_count > 0 && i > res_count) {
|
||
next
|
||
}
|
||
if (i > 1) {
|
||
printf ",\n"
|
||
}
|
||
|
||
printf "\n\t\t{\n"
|
||
printf "\t\t\t\"date\": \"%s\",\n", $1
|
||
printf "\t\t\t\"time\": \"%s\",\n", $2
|
||
printf "\t\t\t\"client\": \"%s\",\n", $3
|
||
printf "\t\t\t\"iface\": \"%s\",\n", $4
|
||
printf "\t\t\t\"type\": \"%s\",\n", $5
|
||
printf "\t\t\t\"domain\": \"%s\",\n", $6
|
||
printf "\t\t\t\"rc\": \"%s\"\n", $7
|
||
printf "\t\t}"
|
||
}
|
||
END {
|
||
printf "\n\t]\n}\n"
|
||
}' "${report_srt}" >> "${report_jsn}"
|
||
"${adb_rmcmd}" -f "${report_srt}"
|
||
fi
|
||
|
||
# retrieve/prepare map data
|
||
#
|
||
if [ "${adb_map}" = "1" ] && [ -s "${report_jsn}" ]; then
|
||
cnt="1"
|
||
network_find_wan iface_v4 && network_get_ipaddr ip_v4 "${iface_v4}"
|
||
network_find_wan6 iface_v6 && network_get_ipaddr6 ip_v6 "${iface_v6}"
|
||
if [ -n "${ip_v4}" ] || [ -n "${ip_v6}" ]; then
|
||
f_fetch
|
||
printf '%s' ",[{}" >"${map_jsn}"
|
||
fi
|
||
for ip in ${ip_v4} ${ip_v6}; do
|
||
(
|
||
"${adb_fetchcmd}" ${adb_geoparm} "${adb_geourl}/${ip}" 2>>"${adb_errorlog}" |
|
||
"${adb_awkcmd}" -v feed="homeIP" '{printf ",{\"%s\": %s}\n",feed,$0}' > "${map_jsn}.${cnt}"
|
||
) &
|
||
[ "${cnt}" -gt "${adb_cores}" ] && wait -n
|
||
cnt="$((cnt + 1))"
|
||
done
|
||
wait
|
||
if [ -s "${map_jsn}" ] && [ "${cnt}" -lt "45" ]; then
|
||
map_seen=""
|
||
json_init
|
||
if json_load_file "${report_jsn}" >/dev/null 2>&1; then
|
||
json_select "requests" >/dev/null 2>&1
|
||
json_get_keys requests >/dev/null 2>&1
|
||
for request in ${requests}; do
|
||
json_select "${request}" >/dev/null 2>&1
|
||
json_get_var rc "rc" >/dev/null 2>&1
|
||
json_get_var domain "domain" >/dev/null 2>&1
|
||
if [ "${rc}" = "NX" ]; then
|
||
case " ${map_seen} " in
|
||
*" ${domain} "*)
|
||
;;
|
||
*)
|
||
map_seen="${map_seen} ${domain} "
|
||
(
|
||
"${adb_fetchcmd}" ${adb_geoparm} "${adb_geourl}/${domain}" 2>>"${adb_errorlog}" |
|
||
"${adb_awkcmd}" -v feed="${domain}" '{printf ",{\"%s\": %s}\n",feed,$0}' > "${map_jsn}.${cnt}"
|
||
) &
|
||
[ "${cnt}" -gt "${adb_cores}" ] && wait -n
|
||
cnt="$((cnt + 1))"
|
||
[ "${cnt}" -ge "45" ] && break
|
||
;;
|
||
esac
|
||
fi
|
||
json_select ".."
|
||
done
|
||
wait
|
||
fi
|
||
fi
|
||
for file in "${map_jsn}".*; do
|
||
[ -s "${file}" ] || continue
|
||
"${adb_catcmd}" "${map_jsn}".* >> "${map_jsn}" 2>/dev/null
|
||
"${adb_rmcmd}" -f "${map_jsn}".*
|
||
break
|
||
done
|
||
fi
|
||
fi
|
||
|
||
# output preparation
|
||
#
|
||
if [ -s "${report_jsn}" ] && { [ "${action}" = "cli" ] || [ "${action}" = "mail" ]; }; then
|
||
printf '%s\n%s\n%s\n' ":::" "::: Adblock DNS Report" ":::" >>"${report_txt}"
|
||
json_init
|
||
json_load_file "${report_jsn}"
|
||
json_get_keys key_list
|
||
for key in ${key_list}; do
|
||
json_get_var value "${key}"
|
||
case "${key}" in
|
||
*[!a-z_]*)
|
||
;;
|
||
*)
|
||
eval "${key}=\"\${value}\""
|
||
;;
|
||
esac
|
||
done
|
||
printf ' + %s\n + %s\n' "Start ::: ${start_date}, ${start_time}" "End ::: ${end_date}, ${end_time}" >>"${report_txt}"
|
||
printf ' + %s\n + %s %s\n' "Total ::: ${total}" "Blocked ::: ${blocked}" "(${percent})" >>"${report_txt}"
|
||
top_list="top_clients top_domains top_blocked requests"
|
||
for top in ${top_list}; do
|
||
case "${top}" in
|
||
"top_clients")
|
||
item="::: Top Clients"
|
||
;;
|
||
"top_domains")
|
||
item="::: Top Domains"
|
||
;;
|
||
"top_blocked")
|
||
item="::: Top Blocked Domains"
|
||
;;
|
||
esac
|
||
if json_get_type status "${top}" && [ "${top}" != "requests" ] && [ "${status}" = "array" ]; then
|
||
printf '%s\n%s\n%s\n' ":::" "${item}" ":::" >>"${report_txt}"
|
||
json_select "${top}"
|
||
index="1"
|
||
item=""
|
||
while json_get_type status "${index}" && [ "${status}" = "object" ]; do
|
||
json_get_values item "${index}"
|
||
printf ' + %-9s::: %s\n' ${item} >>"${report_txt}"
|
||
index="$((index + 1))"
|
||
done
|
||
elif json_get_type status "${top}" && [ "${top}" = "requests" ] && [ "${status}" = "array" ]; then
|
||
printf '%s\n%s\n%s\n' ":::" "::: Latest DNS Queries" ":::" >>"${report_txt}"
|
||
printf '%-11s%-9s%-40s%-15s%-5s%-70s%s\n' "Date" "Time" "Client" "Interface" "Type" "Domain" "Answer" >>"${report_txt}"
|
||
json_select "${top}"
|
||
index="1"
|
||
while json_get_type status "${index}" && [ "${status}" = "object" ]; do
|
||
json_get_values item "${index}"
|
||
printf '%-11s%-9s%-40s%-15s%-5s%-70s%s\n' ${item} >>"${report_txt}"
|
||
index="$((index + 1))"
|
||
done
|
||
fi
|
||
json_select ".."
|
||
done
|
||
content="$("${adb_catcmd}" "${report_txt}" 2>>"${adb_errorlog}")"
|
||
"${adb_rmcmd}" -f "${report_txt}"
|
||
fi
|
||
|
||
# report output
|
||
#
|
||
case "${action}" in
|
||
"cli")
|
||
printf '%s\n' "${content}"
|
||
;;
|
||
"json")
|
||
if [ "${adb_map}" = "1" ] && [ -s "${map_jsn}" ]; then
|
||
jsn="$("${adb_catcmd}" ${report_jsn} ${map_jsn} 2>>"${adb_errorlog}")"
|
||
[ -n "${jsn}" ] && printf '[%s]]\n' "${jsn}"
|
||
else
|
||
jsn="$("${adb_catcmd}" "${report_jsn}" 2>>"${adb_errorlog}")"
|
||
[ -n "${jsn}" ] && printf '[%s]\n' "${jsn}"
|
||
fi
|
||
;;
|
||
"mail")
|
||
[ "${adb_mail}" = "1" ] && [ -x "${adb_mailservice}" ] && "${adb_mailservice}" "${content}" >/dev/null 2>&1
|
||
"${adb_rmcmd}" -f "${report_txt}"
|
||
;;
|
||
"gen")
|
||
printf '%s\n' "1" >"/var/run/adblock.report"
|
||
;;
|
||
esac
|
||
}
|
||
|
||
# source required system libraries
|
||
#
|
||
if [ -r "/lib/functions.sh" ] && [ -r "/lib/functions/network.sh" ] && [ -r "/usr/share/libubox/jshn.sh" ]; then
|
||
. "/lib/functions.sh"
|
||
. "/lib/functions/network.sh"
|
||
. "/usr/share/libubox/jshn.sh"
|
||
else
|
||
f_log "err" "system libraries not found"
|
||
fi
|
||
|
||
# reference required system utilities
|
||
#
|
||
adb_wccmd="$(f_cmd wc)"
|
||
adb_mvcmd="$(f_cmd mv)"
|
||
adb_lncmd="$(f_cmd ln)"
|
||
adb_rmcmd="$(f_cmd rm)"
|
||
adb_catcmd="$(f_cmd cat)"
|
||
adb_zcatcmd="$(f_cmd zcat)"
|
||
adb_awkcmd="$(f_cmd gawk awk)"
|
||
adb_sortcmd="$(f_cmd sort)"
|
||
adb_grepcmd="$(f_cmd grep)"
|
||
adb_gzipcmd="$(f_cmd gzip)"
|
||
adb_pgrepcmd="$(f_cmd pgrep)"
|
||
adb_sedcmd="$(f_cmd sed)"
|
||
adb_findcmd="$(f_cmd find)"
|
||
adb_jsoncmd="$(f_cmd jsonfilter)"
|
||
adb_ubuscmd="$(f_cmd ubus)"
|
||
adb_loggercmd="$(f_cmd logger)"
|
||
adb_lookupcmd="$(f_cmd nslookup)"
|
||
adb_dumpcmd="$(f_cmd tcpdump optional)"
|
||
adb_mailcmd="$(f_cmd msmtp optional)"
|
||
adb_logreadcmd="$(f_cmd logread optional)"
|
||
adb_nftcmd="$(f_cmd nft)"
|
||
|
||
# handle different adblock actions
|
||
#
|
||
f_load
|
||
case "${adb_action}" in
|
||
"stop")
|
||
f_temp
|
||
f_nftremove
|
||
f_rmdns
|
||
f_jsnup "stopped"
|
||
;;
|
||
"suspend")
|
||
[ "${adb_dns}" != "raw" ] && f_switch suspend
|
||
;;
|
||
"resume")
|
||
[ "${adb_dns}" != "raw" ] && f_switch resume
|
||
;;
|
||
"report")
|
||
f_report "${2}" "${3}" "${4}" "${5}"
|
||
;;
|
||
"search")
|
||
f_search "${2}"
|
||
;;
|
||
"boot" | "start" | "reload")
|
||
f_env
|
||
f_main
|
||
;;
|
||
"restart")
|
||
f_temp
|
||
f_jsnup "processing"
|
||
f_rmdns
|
||
f_env
|
||
f_main
|
||
;;
|
||
esac
|