pi-hole/advanced/Scripts/blacklist.sh

188 lines
5.1 KiB
Bash
Raw Normal View History

2016-01-17 14:09:06 +00:00
#!/usr/bin/env bash
2016-01-30 20:12:40 +00:00
# Pi-hole: A black hole for Internet advertisements
# (c) 2015, 2016 by Jacob Salmela
# Network-wide ad blocking via your Raspberry Pi
# http://pi-hole.net
# Blacklists domains
2016-01-17 14:09:06 +00:00
#
# Pi-hole is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
if [[ $# = 0 ]]; then
echo "::: Immediately blacklists one or more domains in the hosts file"
echo ":::"
echo "::: Usage: sudo pihole.sh -b domain1 [domain2 ...]"
echo ":::"
echo "::: Options:"
echo "::: -d, --delmode Remove domains from the blacklist"
echo "::: -nr, --noreload Update blacklist without refreshing dnsmasq"
echo "::: -f, --force Force updating of the hosts files, even if there are no changes"
echo "::: -q, --quiet output is less verbose"
2016-01-17 14:09:06 +00:00
exit 1
fi
#globals
blacklist=/etc/pihole/blacklist.txt
adList=/etc/pihole/gravity.list
reload=true
addmode=true
force=false
versbose=true
domList=()
domToRemoveList=()
piholeIPv6file=/etc/pihole/.useIPv6
# Otherwise, the IP address can be taken directly from the machine, which will happen when the script is run by the user and not the installation script
IPv4dev=$(ip route get 8.8.8.8 | awk '{for(i=1;i<=NF;i++)if($i~/dev/)print $(i+1)}')
piholeIPCIDR=$(ip -o -f inet addr show dev "$IPv4dev" | awk '{print $4}' | awk 'END {print}')
2016-01-17 14:09:06 +00:00
piholeIP=${piholeIPCIDR%/*}
modifyHost=false
if [[ -f $piholeIPv6file ]];then
# If the file exists, then the user previously chose to use IPv6 in the automated installer
piholeIPv6=$(ip -6 route get 2001:4860:4860::8888 | awk -F " " '{ for(i=1;i<=NF;i++) if ($i == "src") print $(i+1) }')
fi
function HandleOther(){
2016-01-17 14:09:06 +00:00
#check validity of domain
validDomain=$(echo "$1" | perl -ne'print if /\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b/')
2016-01-17 14:09:06 +00:00
if [ -z "$validDomain" ]; then
echo "::: $1 is not a valid argument or domain name"
2016-01-17 14:09:06 +00:00
else
domList=("${domList[@]}" $validDomain)
fi
}
function PopBlacklistFile(){
#check blacklist file exists, and if not, create it
if [[ ! -f $blacklist ]];then
touch $blacklist
fi
2016-03-28 17:53:21 +00:00
for dom in "${domList[@]}"; do
if "$addmode"; then
AddDomain "$dom"
2016-01-17 14:09:06 +00:00
else
RemoveDomain "$dom"
2016-01-17 14:09:06 +00:00
fi
done
}
function AddDomain(){
#| sed 's/\./\\./g'
bool=false
grep -Ex -q "$1" $blacklist || bool=true
if $bool; then
#domain not found in the blacklist file, add it!
if $versbose; then
2016-01-24 17:18:37 +00:00
echo -n "::: Adding $1 to blacklist file..."
2016-01-17 14:09:06 +00:00
fi
echo "$1" >> $blacklist
2016-01-17 14:09:06 +00:00
modifyHost=true
2016-01-24 17:18:37 +00:00
echo " done!"
2016-01-17 14:09:06 +00:00
else
if $versbose; then
2016-01-24 17:18:37 +00:00
echo "::: $1 already exists in blacklist.txt! No need to add"
2016-01-17 14:09:06 +00:00
fi
fi
}
function RemoveDomain(){
2016-01-17 14:09:06 +00:00
bool=false
grep -Ex -q "$1" $blacklist || bool=true
if $bool; then
#Domain is not in the blacklist file, no need to Remove
if $versbose; then
2016-01-24 17:18:37 +00:00
echo "::: $1 is NOT blacklisted! No need to remove"
2016-01-17 14:09:06 +00:00
fi
else
#Domain is in the blacklist file, add to a temporary array
if $versbose; then
2016-01-24 17:18:37 +00:00
echo "::: Un-blacklisting $dom..."
2016-01-17 14:09:06 +00:00
fi
domToRemoveList=("${domToRemoveList[@]}" $1)
modifyHost=true
fi
2016-01-17 14:09:06 +00:00
}
function ModifyHostFile(){
2016-01-17 14:09:06 +00:00
if $addmode; then
#add domains to the hosts file
if [[ -r $blacklist ]];then
numberOf=$($blacklist | sed '/^\s*$/d' | wc -l)
2016-01-17 14:09:06 +00:00
plural=; [[ "$numberOf" != "1" ]] && plural=s
2016-01-24 17:18:37 +00:00
echo ":::"
echo -n "::: Modifying HOSTS file to blacklist $numberOf domain${plural}..."
2016-01-17 14:09:06 +00:00
if [[ -n $piholeIPv6 ]];then
$blacklist | awk -v ipv4addr="$piholeIP" -v ipv6addr="$piholeIPv6" '{sub(/\r$/,""); print ipv4addr" "$0"\n"ipv6addr" "$0}' >> $adList
2016-03-28 17:53:21 +00:00
else
$blacklist | awk -v ipv4addr="$piholeIP" '{sub(/\r$/,""); print ipv4addr" "$0}' >>$adList
2016-03-28 17:53:21 +00:00
fi
2016-01-17 14:09:06 +00:00
fi
else
2016-01-24 17:18:37 +00:00
echo ":::"
2016-03-28 18:07:51 +00:00
for dom in "${domToRemoveList[@]}"
do
#we need to remove the domains from the blacklist file and the host file
2016-03-28 17:53:21 +00:00
echo "::: $dom"
echo -n "::: removing from HOSTS file..."
echo "$dom" | sed 's/\./\\./g' | xargs -I {} perl -i -ne'print unless /[^.]'{}'(?!.)/;' $adList
echo " done!"
echo -n "::: removing from blackist.txt..."
echo "$dom" | sed 's/\./\\./g' | xargs -I {} perl -i -ne'print unless /'{}'(?!.)/;' $blacklist
echo " done!"
done
2016-03-28 17:53:21 +00:00
fi
2016-01-17 14:09:06 +00:00
}
function Reload() {
# Reload hosts file
2016-01-24 17:18:37 +00:00
echo ":::"
echo -n "::: Refresh lists in dnsmasq..."
2016-01-17 14:09:06 +00:00
dnsmasqPid=$(pidof dnsmasq)
if [[ $dnsmasqPid ]]; then
# service already running - reload config
sudo kill -HUP "$dnsmasqPid"
2016-01-17 14:09:06 +00:00
else
# service not running, start it up
sudo service dnsmasq start
fi
2016-01-24 17:18:37 +00:00
echo " done!"
2016-01-17 14:09:06 +00:00
}
###################################################
for var in "$@"
do
case "$var" in
"-nr"| "--noreload" ) reload=false;;
2016-01-17 14:09:06 +00:00
"-d" | "--delmode" ) addmode=false;;
"-f" | "--force" ) force=true;;
"-q" | "--quiet" ) versbose=false;;
* ) HandleOther "$var";;
2016-01-17 14:09:06 +00:00
esac
done
PopBlacklistFile
if $modifyHost || $force; then
2016-01-17 14:09:06 +00:00
ModifyHostFile
else
if $versbose; then
2016-01-24 17:18:37 +00:00
echo "::: No changes need to be made"
2016-01-17 14:09:06 +00:00
fi
exit 1
fi
if $reload; then
Reload
fi