@ -9,11 +9,11 @@
# Please see LICENSE file for your rights under this license.
# Please see LICENSE file for your rights under this license.
readonly PI_HOLE_SCRIPT_DIR="/opt/pihole"
readonly PI_HOLE_SCRIPT_DIR="/opt/pihole"
readonly wildcardlist="/etc/dnsmasq.d/03-pihole-wildcard.conf"
readonly wildcardlist="/etc/dnsmasq.d/03-pihole-wildcard.conf"
# Must be root to use this tool
# Must be root to use this tool
if [[ ! $EUID -eq 0 ]];then
if [[ ! $EUID -eq 0 ]];then
if [ -x "$(command -v sudo)" ];then
if [[ -x "$(command -v sudo)" ]] ; then
exec sudo bash "$0" "$@"
exec sudo bash "$0" "$@"
exit $?
exit $?
else
else
@ -80,66 +80,49 @@ updateGravityFunc() {
exit 0
exit 0
}
}
scanList(){
scanList() {
domain="${1}"
domain="${1}"
list="${2}"
list="${2}"
method="${3}"
method="${3}"
if [[ ${method} == "-exact" ]] ; then
grep -i -E "(^|\s)${domain}($|\s)" "${list}"
if [[ "${method}" == "-exact" ]]; then
grep -i -E -l "(^|\s|\/)${domain}($|\s|\/)" ${list}
else
else
grep -i "${domain}" " ${list}"
grep -i "${domain}" ${list}
fi
fi
}
}
processWildcards() {
IFS="." read -r -a array <<< "${1}"
for (( i=${#array[@]}-1; i>=0; i-- )); do
ar=""
for (( j=${#array[@]}-1; j>${#array[@]}-i-2; j-- )); do
if [[ $j == $((${#array[@]}-1)) ]]; then
ar="${array[$j]}"
else
ar="${array[$j]}.${ar}"
fi
done
echo "${ar}"
done
}
queryFunc() {
queryFunc() {
domain="${2}"
method="${3}"
method="${3}"
lists=( /etc/pihole/list.* /etc/pihole/blacklist.txt)
for list in ${lists[@]}; do
# If domain contains non ASCII characters, convert domain to punycode if python exists
if [ -e "${list}" ]; then
# Cr: https://serverfault.com/a/335079
result=$(scanList ${domain} ${list} ${method})
if [[ -z "${2}" ]]; then
# Remove empty lines before couting number of results
echo "::: No domain specified"
count=$(sed '/^\s*$/d' <<< "$result" | wc -l)
exit 1
echo "::: ${list} (${count} results)"
elif [[ "${2}" = *[![:ascii:]]* ]]; then
if [[ ${count} > 0 ]]; then
[[ "$(which python)" ]] && domain=$(python -c 'import sys;print sys.argv[1].decode("utf-8").encode("idna")' "${2}")
echo "${result}"
else
fi
domain="${2}"
echo ""
fi
else
echo "::: ${list} does not exist"
# Scan Whitelist, Blacklist and Wildcards
echo ""
lists="/etc/pihole/whitelist.txt /etc/pihole/blacklist.txt $wildcardlist"
fi
result=$(scanList ${domain} "${lists}" ${method})
done
if [[ -n "$result" ]]; then
echo "$result"
# Scan for possible wildcard matches
[[ ! -t 1 ]] && exit 0
if [ -e "${wildcardlist}" ]; then
fi
local wildcards=($(processWildcards "${domain}"))
for domain in ${wildcards[@]}; do
# Scan Domains lists
result=$(scanList "\/${domain}\/" ${wildcardlist})
result=$(scanList ${domain} "/etc/pihole/*.domains" ${method})
# Remove empty lines before couting number of results
if [[ -n "$result" ]]; then
count=$(sed '/^\s*$/d' <<< "$result" | wc -l)
sort -t . -k 2 -g <<< "$result"
if [[ ${count} > 0 ]]; then
else
echo "::: Wildcard blocking ${domain} (${count} results)"
[ -n "$method" ] && exact="exact "
echo "${result}"
echo "::: No ${exact}results found for ${domain}"
echo ""
fi
done
fi
fi
exit 0
exit 0
}
}
@ -163,16 +146,16 @@ versionFunc() {
restartDNS() {
restartDNS() {
dnsmasqPid=$(pidof dnsmasq)
dnsmasqPid=$(pidof dnsmasq)
if [[ ${dnsmasqPid} ]]; then
if [[ " ${dnsmasqPid}" ]]; then
# s ervice already running - reload config
# S ervice already running - reload config
if [ -x "$(command -v systemctl)" ]; then
if [[ -x "$(command -v systemctl)" ] ]; then
systemctl restart dnsmasq
systemctl restart dnsmasq
else
else
service dnsmasq restart
service dnsmasq restart
fi
fi
else
else
# s ervice not running, start it up
# S ervice not running, start it up
if [ -x "$(command -v systemctl)" ]; then
if [[ -x "$(command -v systemctl)" ] ]; then
systemctl start dnsmasq
systemctl start dnsmasq
else
else
service dnsmasq start
service dnsmasq start
@ -181,16 +164,25 @@ restartDNS() {
}
}
piholeEnable() {
piholeEnable() {
if [[ "${1}" == "0" ]] ; then
if [[ "${2}" == "-h" ]]; then
#Disable Pihole
echo "Usage: pihole disable [time]
Example: 'pihole disable', or 'pihole disable 5m'
Disable Pi-hole subsystems
Time:
#s Disable Pi-hole functionality for # second(s)
#m Disable Pi-hole functionality for # minute(s)"
exit 0
elif [[ "${1}" == "0" ]]; then
# Disable Pi-hole
sed -i 's/^addn-hosts=\/etc\/pihole\/gravity.list/#addn-hosts=\/etc\/pihole\/gravity.list/' /etc/dnsmasq.d/01-pihole.conf
sed -i 's/^addn-hosts=\/etc\/pihole\/gravity.list/#addn-hosts=\/etc\/pihole\/gravity.list/' /etc/dnsmasq.d/01-pihole.conf
echo "::: Blocking has been disabled!"
echo "::: Blocking has been disabled!"
if [[ $# > 1 ]] ; then
if [[ $# > 1 ]]; then
if [[ ${2} == *"s"* ]] ; then
if [[ " ${2}" == *"s"* ]]; then
tt=${2%"s"}
tt=${2%"s"}
echo "::: Blocking will be re-enabled in ${tt} seconds"
echo "::: Blocking will be re-enabled in ${tt} seconds"
nohup bash -c "sleep ${tt}; pihole enable" </dev/null &>/dev/null &
nohup bash -c "sleep ${tt}; pihole enable" </dev/null &>/dev/null &
elif [[ ${2} == *"m"* ]] ; then
elif [[ " ${2}" == *"m"* ]]; then
tt=${2%"m"}
tt=${2%"m"}
echo "::: Blocking will be re-enabled in ${tt} minutes"
echo "::: Blocking will be re-enabled in ${tt} minutes"
tt=$((${tt}*60))
tt=$((${tt}*60))
@ -204,7 +196,7 @@ piholeEnable() {
fi
fi
fi
fi
else
else
#Enable pi hole
# Enable Pi- hole
echo "::: Blocking has been enabled!"
echo "::: Blocking has been enabled!"
sed -i 's/^#addn-hosts/addn-hosts/' /etc/dnsmasq.d/01-pihole.conf
sed -i 's/^#addn-hosts/addn-hosts/' /etc/dnsmasq.d/01-pihole.conf
fi
fi
@ -213,15 +205,23 @@ piholeEnable() {
piholeLogging() {
piholeLogging() {
shift
shift
if [[ "${1}" == "-h" ]]; then
if [[ "${1}" == "off" ]] ; then
echo "Usage: pihole logging [options]
#Disable Logging
Example: 'pihole logging on'
Specify whether the Pi-hole log should be used
Options:
on Enable the Pi-hole log at /var/log/pihole.log
off Disable the Pi-hole log at /var/log/pihole.log"
exit 0
elif [[ "${1}" == "off" ]]; then
# Disable logging
sed -i 's/^log-queries/#log-queries/' /etc/dnsmasq.d/01-pihole.conf
sed -i 's/^log-queries/#log-queries/' /etc/dnsmasq.d/01-pihole.conf
sed -i 's/^QUERY_LOGGING=true/QUERY_LOGGING=false/' /etc/pihole/setupVars.conf
sed -i 's/^QUERY_LOGGING=true/QUERY_LOGGING=false/' /etc/pihole/setupVars.conf
pihole -f
pihole -f
echo "::: Logging has been disabled!"
echo "::: Logging has been disabled!"
elif [[ "${1}" == "on" ]] ; then
elif [[ "${1}" == "on" ]]; then
#Enable logging
# Enable logging
sed -i 's/^#log-queries/log-queries/' /etc/dnsmasq.d/01-pihole.conf
sed -i 's/^#log-queries/log-queries/' /etc/dnsmasq.d/01-pihole.conf
sed -i 's/^QUERY_LOGGING=false/QUERY_LOGGING=true/' /etc/pihole/setupVars.conf
sed -i 's/^QUERY_LOGGING=false/QUERY_LOGGING=true/' /etc/pihole/setupVars.conf
echo "::: Logging has been enabled!"
echo "::: Logging has been enabled!"
@ -233,12 +233,12 @@ piholeLogging() {
}
}
piholeStatus() {
piholeStatus() {
if [[ $(netstat -plnt | grep -c ':53 ') > 0 ]]; then
if [[ "$(netstat -plnt | grep -c ':53 ')" -gt "0" ]]; then
if [[ "${1}" != "web" ]] ; then
if [[ "${1}" != "web" ]]; then
echo "::: DNS service is running"
echo "::: DNS service is running"
fi
fi
else
else
if [[ "${1}" == "web" ]] ; then
if [[ "${1}" == "web" ]]; then
echo "-1";
echo "-1";
else
else
echo "::: DNS service is NOT running"
echo "::: DNS service is NOT running"
@ -246,28 +246,28 @@ piholeStatus() {
return
return
fi
fi
if [[ $(grep -i "^#addn-hosts=/" /etc/dnsmasq.d/01-pihole.conf) ]] ; then
if [[ " $(grep -i "^#addn-hosts=/" /etc/dnsmasq.d/01-pihole.conf)" ]]; then
#l ist is commented out
# L ist is commented out
if [[ "${1}" == "web" ]] ; then
if [[ "${1}" == "web" ]]; then
echo 0;
echo 0;
else
else
echo "::: Pi-hole blocking is Disabled";
echo "::: Pi-hole blocking is Disabled";
fi
fi
elif [[ $(grep -i "^addn-hosts=/" /etc/dnsmasq.d/01-pihole.conf) ]] ; then
elif [[ " $(grep -i "^addn-hosts=/" /etc/dnsmasq.d/01-pihole.conf)" ]]; then
#l ist set
# L ist set
if [[ "${1}" == "web" ]] ; then
if [[ "${1}" == "web" ]]; then
echo 1;
echo 1;
else
else
echo "::: Pi-hole blocking is Enabled";
echo "::: Pi-hole blocking is Enabled";
fi
fi
else
else
#a ddn-host not found
# A ddn-host not found
if [[ "${1}" == "web" ]] ; then
if [[ "${1}" == "web" ]]; then
echo 99
echo 99
else
else
echo "::: No hosts file linked to dnsmasq, adding it in enabled state"
echo "::: No hosts file linked to dnsmasq, adding it in enabled state"
fi
fi
#a dd addn-host= to dnsmasq
# A dd addn-host= to dnsmasq
echo "addn-hosts=/etc/pihole/gravity.list" >> /etc/dnsmasq.d/01-pihole.conf
echo "addn-hosts=/etc/pihole/gravity.list" >> /etc/dnsmasq.d/01-pihole.conf
restartDNS
restartDNS
fi
fi
@ -280,46 +280,66 @@ tailFunc() {
}
}
piholeCheckoutFunc() {
piholeCheckoutFunc() {
if [[ "$2" == "-h" ]]; then
echo "Usage: pihole checkout [repo] [branch]
Example: 'pihole checkout master' or 'pihole checkout core dev'
Switch Pi-hole subsystems to a different Github branch
Repositories:
core [branch] Change the branch of Pi-hole's core subsystem
web [branch] Change the branch of Admin Console subsystem
Branches:
master Update subsystems to the latest stable release
dev Update subsystems to the latest development release"
exit 0
fi
source "${PI_HOLE_SCRIPT_DIR}"/piholeCheckout.sh
source "${PI_HOLE_SCRIPT_DIR}"/piholeCheckout.sh
shift
shift
checkout "$@"
checkout "$@"
}
}
helpFunc() {
helpFunc() {
cat << EOM
echo "Usage: pihole [options]
::: Control all Pi-hole specific functions
Example: 'pihole -w -h'
:::
Add '-h' after specific commands for more information on usage
::: Usage: pihole [options]
::: Add -h after -w (whitelist), -b (blacklist), -c (chronometer), or -a (admin) for more information on usage
Whitelist/Blacklist Options:
:::
-w, whitelist Whitelist domain(s)
::: Options:
-b, blacklist Blacklist domain(s)
::: -w, whitelist Whitelist domain(s)
-wild, wildcard Blacklist domain(s), and all its subdomains
::: -b, blacklist Blacklist domain(s) (exact match)
Add '-h' for more info on whitelist/blacklist usage
::: -wild, wildcard Blacklist whole domain(s) (wildcard)
::: -d, debug Start a debugging session
Debugging Options:
::: Automated debugging can be enabled with '-a'.
-d, debug Start a debugging session
::: 'pihole -d -a'
Add '-a' to enable automated debugging
::: -f, flush Flush the 'pihole.log' file
-f, flush Flush the Pi-hole log
::: -t, tail Output the last lines of the 'pihole.log' file. Lines are appended as the file grows
-r, reconfigure Reconfigure or Repair Pi-hole subsystems
::: -up, updatePihole Update Pi-hole components
-t, tail View the live output of the Pi-hole log
::: -r, reconfigure Reconfigure or Repair Pi-hole
::: -g, updateGravity Update the list of ad-serving domains
Options:
::: -c, chronometer Calculates stats and displays to an LCD
-a, admin Admin Console options
::: -h, help Show this help dialog
Add '-h' for more info on admin console usage
::: -v, version Show installed versions of Pi-hole and Web-Admin
-c, chronometer Calculates stats and displays to an LCD
::: -q, query Query the adlists for a specific domain
Add '-h' for more info on chronometer usage
::: 'pihole -q domain -exact' shows exact matches only
-g, updateGravity Update the list of ad-serving domains
::: -l, logging Enable or Disable logging (pass 'on' or 'off')
-h, --help, help Show this help dialog
::: -a, admin Admin webpage options
-l, logging Specify whether the Pi-hole log should be used
::: uninstall Uninstall Pi-hole from your system! :(
Add '-h' for more info on logging usage
::: status Display if Pi-hole is Enabled or Disabled
-q, query Query the adlists for a specified domain
::: enable Enable Pi-hole DNS Blocking
Add '-exact' AFTER a specified domain for exact match
::: disable Disable Pi-hole DNS Blocking
-up, updatePihole Update Pi-hole subsystems
::: Blocking can also be disabled only temporarily, e.g.,
-v, version Show installed versions of Pi-hole, Admin Console & FTL
::: 'pihole disable 5m' - will disable blocking for 5 minutes
Add '-h' for more info on version usage
::: restartdns Restart dnsmasq
uninstall Uninstall Pi-hole from your system
::: checkout Check out different branches
status Display the running status of Pi-hole subsystems
EOM
enable Enable Pi-hole subsystems
disable Disable Pi-hole subsystems
Add '-h' for more info on disable usage
restartdns Restart Pi-hole subsystems
checkout Switch Pi-hole subsystems to a different Github branch
Add '-h' for more info on checkout usage";
exit 0
exit 0
}
}
@ -344,7 +364,7 @@ case "${1}" in
"-l" | "logging" ) piholeLogging "$@";;
"-l" | "logging" ) piholeLogging "$@";;
"uninstall" ) uninstallFunc;;
"uninstall" ) uninstallFunc;;
"enable" ) piholeEnable 1;;
"enable" ) piholeEnable 1;;
"disable" ) piholeEnable 0 $2;;
"disable" ) piholeEnable 0 " $2" ;;
"status" ) piholeStatus "$2";;
"status" ) piholeStatus "$2";;
"restartdns" ) restartDNS;;
"restartdns" ) restartDNS;;
"-a" | "admin" ) webpageFunc "$@";;
"-a" | "admin" ) webpageFunc "$@";;
WaLLy3K
7 years ago
committed by