Merge pull request #1065 from pi-hole/wildcardblacklisting

Add blacklisting wildcard support

advanced/Scripts/list.sh

@@ -15,6 +15,7 @@ basename=pihole
 piholeDir=/etc/${basename}
 whitelist=${piholeDir}/whitelist.txt
 blacklist=${piholeDir}/blacklist.txt
+readonly wildcardlist="/etc/dnsmasq.d/03-pihole-wildcard.conf"
 reload=false
 addmode=true
 verbose=true
@@ -47,13 +48,17 @@ helpFunc() {
 :::  -h, --help				Show this help dialog
 :::  -l, --list				Display your ${word}listed domains
 EOM
+if [[ "${letter}" == "b" ]]; then
+	echo ":::  -wild, --wildcard		Add whitecard entry (only blacklist)"
+fi
 	exit 0
 }
 
 EscapeRegexp() {
     # This way we may safely insert an arbitrary
     # string in our regular expressions
-    echo $* | sed "s/[]\\.|$(){}?+*^]/\\\\&/g" | sed "s/\\//\\\\\//g"
+    # Also remove leading "." if present
+    echo $* | sed 's/^\.//' | sed "s/[]\\.|$(){}?+*^]/\\\\&/g" | sed "s/\\//\\\\\//g"
 }
 
 HandleOther(){
@@ -89,9 +94,11 @@ AddDomain() {
 	list="$2"
     domain=$(EscapeRegexp "$1")
 
+    if [[ "${list}" == "${whitelist}" || "${list}" == "${blacklist}" ]]; then
+
 		bool=true
 		#Is the domain in the list we want to add it to?
-	grep -Ex -q "${domain}" ${list} > /dev/null 2>&1 || bool=false
+		grep -Ex -q "${domain}" "${list}" > /dev/null 2>&1 || bool=false
 
 		if [[ "${bool}" == false ]]; then
 		  #domain not found in the whitelist file, add it!
@@ -100,32 +107,79 @@ AddDomain() {
 		  fi
 		  reload=true
 		  # Add it to the list we want to add it to
-	  echo "$1" >> ${list}
+		  echo "$1" >> "${list}"
 		else
 	        if [[ "${verbose}" == true ]]; then
 	            echo "::: ${1} already exists in ${list}, no need to add!"
 	        fi
 		fi
+
+	elif [[ "${list}" == "${wildcardlist}" ]]; then
+
+		source "${piholeDir}/setupVars.conf"
+		#Remove the /* from the end of the IPv4addr.
+		IPV4_ADDRESS=${IPV4_ADDRESS%/*}
+		IPV6_ADDRESS=${IPV6_ADDRESS}
+
+		bool=true
+		#Is the domain in the list?
+		grep -e "address=\/${domain}\/" "${wildcardlist}" > /dev/null 2>&1 || bool=false
+
+		if [[ "${bool}" == false ]]; then
+		  if [[ "${verbose}" == true ]]; then
+			echo "::: Adding $1 to wildcard blacklist..."
+		  fi
+		  reload=true
+		  echo "address=/$1/${IPV4_ADDRESS}" >> "${wildcardlist}"
+		  if [[ ${#IPV6_ADDRESS} > 0 ]] ; then
+		    echo "address=/$1/${IPV6_ADDRESS}" >> "${wildcardlist}"
+		  fi
+		else
+	        if [[ "${verbose}" == true ]]; then
+	            echo "::: ${1} already exists in wildcard blacklist, no need to add!"
+	        fi
+		fi
+	fi
 }
 
 RemoveDomain() {
     list="$2"
     domain=$(EscapeRegexp "$1")
 
+    if [[ "${list}" == "${whitelist}" || "${list}" == "${blacklist}" ]]; then
+
         bool=true
         #Is it in the list? Logic follows that if its whitelisted it should not be blacklisted and vice versa
-    grep -Ex -q "${domain}" ${list} > /dev/null 2>&1 || bool=false
+        grep -Ex -q "${domain}" "${list}" > /dev/null 2>&1 || bool=false
         if [[ "${bool}" == true ]]; then
             # Remove it from the other one
             echo "::: Removing $1 from $list..."
             # /I flag: search case-insensitive
-        sed -i "/${domain}/Id" ${list}
+            sed -i "/${domain}/Id" "${list}"
             reload=true
         else
             if [[ "${verbose}" == true ]]; then
                 echo "::: ${1} does not exist in ${list}, no need to remove!"
             fi
         fi
+
+    elif [[ "${list}" == "${wildcardlist}" ]]; then
+
+        bool=true
+        #Is it in the list?
+        grep -e "address=\/${domain}\/" "${wildcardlist}" > /dev/null 2>&1 || bool=false
+        if [[ "${bool}" == true ]]; then
+            # Remove it from the other one
+            echo "::: Removing $1 from $list..."
+            # /I flag: search case-insensitive
+            sed -i "/address=\/${domain}/Id" "${list}"
+            reload=true
+        else
+            if [[ "${verbose}" == true ]]; then
+                echo "::: ${1} does not exist in ${list}, no need to remove!"
+            fi
+        fi
+    fi
 }
 
 Reload() {
@@ -153,6 +207,7 @@ for var in "$@"; do
 	case "${var}" in
 	    "-w" | "whitelist"   ) listMain="${whitelist}"; listAlt="${blacklist}";;
 	    "-b" | "blacklist"   ) listMain="${blacklist}"; listAlt="${whitelist}";;
+		"-wild" | "wildcard" ) listMain="${wildcardlist}";;
 		"-nr"| "--noreload"  ) reload=false;;
 		"-d" | "--delmode"   ) addmode=false;;
 		"-f" | "--force"     ) force=true;;

advanced/index.php

@@ -74,7 +74,9 @@ if($uri == "/")
 		<a class='safe33' id="whitelisting">Whitelist this page</a>
 		<a class='safe33' href='javascript:window.close()'>Close window</a>
 	</div>
-		<div style="width: 98%; text-align: center; padding: 10px;" hidden="true" id="whitelistingform">Password required!<br/>
+		<div style="width: 98%; text-align: center; padding: 10px;" hidden="true" id="whitelistingform">
+			<p>Note that whitelisting domains which are blocked using the wildcard method won't work.</p>
+			<p>Password required!</p><br/>
 		<form>
 			<input name="list" type="hidden" value="white"><br/>
 			Domain:<br/>
@@ -88,6 +90,16 @@ if($uri == "/")
 </main>
 <footer>Generated <?php echo date('D g:i A, M d'); ?> by Pi-hole <?php echo $piHoleVersion; ?></footer>
 <script src="http://pi.hole/admin/scripts/vendor/jquery.min.js"></script>
+<script>
+// Create event for when the output is appended to
+(function($) {
+    var origAppend = $.fn.append;
+
+    $.fn.append = function () {
+        return origAppend.apply(this, arguments).trigger("append");
+    };
+})(jQuery);
+</script>
 <script src="http://pi.hole/admin/scripts/pi-hole/js/queryads.js"></script>
 <script>
 function inIframe () {
@@ -115,6 +127,15 @@ else
 
 $( "#whitelisting" ).on( "click", function(){ $( "#whitelistingform" ).removeAttr( "hidden" ); });
 
+// Remove whitelist functionality if the domain was blocked because of a wildcard
+$( "#output" ).bind("append", function(){
+	if($( "#output" ).contents()[0].data.indexOf("Wildcard blocking") !== -1)
+	{
+		$( "#whitelisting" ).hide();
+		$( "#whitelistingform" ).hide();
+	}
+});
+
 function add() {
 	var domain = $("#domain");
 	var pw = $("#pw");

pihole

@@ -11,6 +11,7 @@
 # (at your option) any later version.
 
 PI_HOLE_SCRIPT_DIR="/opt/pihole"
+readonly wildcardlist="/etc/dnsmasq.d/03-pihole-wildcard.conf"
 # Must be root to use this tool
 if [[ ! $EUID -eq 0 ]];then
   if [ -x "$(command -v sudo)" ];then
@@ -38,6 +39,11 @@ blacklistFunc() {
   exit 0
 }
 
+wildcardFunc() {
+  "${PI_HOLE_SCRIPT_DIR}"/list.sh "$@"
+  exit 0
+}
+
 debugFunc() {
   "${PI_HOLE_SCRIPT_DIR}"/piholeDebug.sh
   exit 0
@@ -79,11 +85,27 @@ scanList(){
   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() {
   domain="${2}"
   method="${3}"
   lists=( /etc/pihole/list.* /etc/pihole/blacklist.txt)
   for list in ${lists[@]}; do
+    if [ -e "${list}" ]; then
       result=$(scanList ${domain} ${list} ${method})
       # Remove empty lines before couting number of results
       count=$(sed '/^\s*$/d' <<< "$result" | wc -l)
@@ -92,6 +114,23 @@ queryFunc() {
         echo "${result}"
       fi
       echo ""
+    else
+      echo "::: ${list} does not exist"
+      echo ""
+    fi
+  done
+
+  # Scan for possible wildcard matches
+  local wildcards=($(processWildcards "${domain}"))
+  for domain in ${wildcards[@]}; do
+    result=$(scanList "\/${domain}\/" ${wildcardlist})
+    # Remove empty lines before couting number of results
+    count=$(sed '/^\s*$/d' <<< "$result" | wc -l)
+    if [[ ${count} > 0 ]]; then
+      echo "::: Wildcard blocking ${domain} (${count} results)"
+      echo "${result}"
+      echo ""
+    fi
   done
   exit 0
 }
@@ -275,6 +314,7 @@ fi
 case "${1}" in
   "-w" | "whitelist"            ) whitelistFunc "$@";;
   "-b" | "blacklist"            ) blacklistFunc "$@";;
+  "-wild" | "wildcard"          ) wildcardFunc "$@";;
   "-d" | "debug"                ) debugFunc;;
   "-f" | "flush"                ) flushFunc;;
   "-up" | "updatePihole"        ) updatePiholeFunc;;