What is it? Response Policy Zone (RPZ) is a mechanism to define local policies in a standardized way and load those policies from external sources. Bottom line: RPZ allows admins to easily block access to websites via DNS lookup. RPZ can block websites via categories. Examples include: fake websites, annoying pop-up ads, newly registered domains, DoH bypass sites, bad "host" services, maliscious top level domains (e.g., *.zip, *.mov), piracy, gambling, pornography, and more. RPZ lists come from various RPZ providers and their available catagories. This RPZ add-on enables the RPZ functionality by adding a couple lines in a configuration file. This add-on simply adds configuration files and adds scripts (config, metrics and sleep) to make RPZ easier for the admin to use. The RPZ scripts include additional languages: German, Spanish, French, Turkish, and Italian. RPZ itself was release in 2010 and has been part of the IPFire build since ~2015. Why is it needed? What is its value? - The RPZ concept places this filtering into IPFire, our internet access gateway, which is (should be) solely used as DNS source of the internal network. - As most sites use HTTPS it makes it difficult to filter traffic with URL Filter without also properly configuring conventional (non-transparent) mode on the proxy. RPZ is a nice replacement for the URL Filter. - No need to install and maintain an additional device like PiHole or AdBlock browser extensions on multiple user devices. - This is an additional layer of protection for users. Less worry someone will click on something that gets them into trouble. And, saying this with emphasis, the ability to do it in one place! - Blocked sites save on unneeded traffic and can lessen the threat of malware in advertisements - Logging allows the admin to see the site blocked and take actions - RPZ will be used at the home, home-office (work from home), schools, ministerial, and at the office. Device counts are small (2-6) to medium (~80) to mediam-large (200+). - RPZ can block ads, popups, phishing, scammers, spyware, malware, annoying popups, NSFW links, DOH servers, and the usual internet trash. ------------------------------ Change Log for RPZ add-on rpz-1.0.0-18 on 2025-02-05 - Build for approval & release as IPFire add-on --- rpz-beta-0.1.18-18.ipfire on 2025-02-01 rpz.cgi: - new feature: added a mod key to force a unbound restart rpz-config and rpz-make: - new feature: added action for unbound restart `rpz-config unbound-restart` rpz-metrics: - simple reformatting - rename far right column from "last update" to "last download" --- rpz-beta-0.1.17-17.ipfire on 2024-12-09 rpz-make - bug fix: corrected validation regex for wildcards like: `*.domain.com` --- rpz-beta-0.1.16-16.ipfire on 2024-11-18 rpz-make - new feature: updated validation regex - bug fix: moved validation to beginning of process. Now we validate before creating config files. rpz.cgi: - new feature: use CSS color variables of the main ipfire theme - bug fix: empty zonefile remarks were stored as “undef” and caused a warning - bug fix: HTML textarea removes the first empty line in a custom list - thank you Leo! --- rpz-beta-0.1.15-15.ipfire on 2024-11-04 rpz.cgi: - new feature: added new language file for Turkish (thank you Peppe) rpz-make - bug fix: corrected empty allow/block list issue. An empty allow/block list will now remove contents of allow/block.rpz files and remove unneeded allow/block.conf file. (thank you iptom) --- rpz-beta-0.1.14-14.ipfire on 2024-10-29 rpz-config: - bug fix: correct missing rpz extension. `rpz-config list` displayed URL incorrectly (thank you Bernhard) rpz.cgi: - bug fix: remove extra `"` in language files (thank you Bernhard) - new feature: slightly dim "apply" button when not enabled --- rpz-beta-0.1.13-13.ipfire on 2024-10-27 - skipped --- rpz-beta-0.1.12-12.ipfire on 2024-10-21 rpz.cgi: - new feature: added new language file for French (thank you gw-ipfire) --- rpz-beta-0.1.11-11.ipfire on 2024-10-18 rpz.cgi: - new feature: added new language file for Italian (thank you umberto) - new feature: added new language file for Spanish (thank you Roberto) --- rpz-beta-0.1.10-10.ipfire on 2024-10-15 rpz-make: - bug fix: corrected validation error for a custom list entry (thank you siosios) - e.g., `*.cloudflare-dns.com` install.sh: - bug fix: add chown to correct user created files update.sh: - bug fix: add chown to correct user created files (thank you siosios) --- rpz-beta-0.1.9-9.ipfire on 2024-10-08 rpz.cgi: - new feature: added new language file for German (thank you Leo) - bug fix: add missing "rpz exitcode 110" - bug fix: corrected missing RPZ menu item at menu > IPFire --- rpz-beta-0.1.8-8.ipfire on 2024-10-04 - skipped --- rpz-beta-0.1.7-7.ipfire on 2024-10-03 All: - new feature: includes beta version numbers for pakfire package, instead of only `rpz-1.0.0-1.ipfire`, for each release. rpz.cgi: - new feature: added new WebGUI at `rpz.cgi` - a BIG thank you to Leo Hofmann for all of his work creating the webgui!! - bug fix: corrected missing RPZ menu item at menu > IPFire rpz-make: - new feature: validate entries in allowlist and blocklist - new feature: add "no-reload" option for WebGUI rpz-metrics: - new feature: info can be sorted by name, by hit count, by line count, by "enabled" list or all lists backups: - bug fix: include all files in `/var/ipfire/dns/rpz` directory in backup update.sh: - bug fix: corrected ownership for `/var/ipfire/dns/rpz` directory during an update Build: - bug fix: `block.rpz.conf` and `block.rpz` from build. Files to be created by `rpz-make` WebGUI and German language file Contribution-by: Leo-Andres Hofmann Spanish language file Contribution-by: Roberto Peña Italian language file Contribution-by: Umberto Parma French language file Contribution-by: gw-ipfire Turkish language file Contribution-by: Peppe Tech Contribution-by: Bernhard Bitsch Contribution-by: Erik Kapfer Signed-off-by: Jon Murphy {'20.rpz'} = { + 'caption' => $Lang::tr{'rpz'}, + 'uri' => '/cgi-bin/rpz.cgi', + 'title' => "RPZ", + 'enabled' => 1, +}; diff --git a/config/rootfiles/common/configroot b/config/rootfiles/common/configroot index 9839eee45..b30d6aae4 100644 --- a/config/rootfiles/common/configroot +++ b/config/rootfiles/common/configroot @@ -120,6 +120,7 @@ var/ipfire/menu.d/70-log.menu #var/ipfire/menu.d/EX-apcupsd.menu #var/ipfire/menu.d/EX-guardian.menu #var/ipfire/menu.d/EX-mympd.menu +#var/ipfire/menu.d/EX-rpz.menu #var/ipfire/menu.d/EX-samba.menu #var/ipfire/menu.d/EX-tor.menu #var/ipfire/menu.d/EX-transmission.menu diff --git a/config/rootfiles/common/web-user-interface b/config/rootfiles/common/web-user-interface index 816241dae..e00464076 100644 --- a/config/rootfiles/common/web-user-interface +++ b/config/rootfiles/common/web-user-interface @@ -69,6 +69,7 @@ srv/web/ipfire/cgi-bin/proxy.cgi srv/web/ipfire/cgi-bin/qos.cgi srv/web/ipfire/cgi-bin/remote.cgi srv/web/ipfire/cgi-bin/routing.cgi +#srv/web/ipfire/cgi-bin/rpz.cgi #srv/web/ipfire/cgi-bin/samba.cgi srv/web/ipfire/cgi-bin/services.cgi srv/web/ipfire/cgi-bin/shutdown.cgi diff --git a/config/rootfiles/packages/rpz b/config/rootfiles/packages/rpz new file mode 100644 index 000000000..1c8663049 --- /dev/null +++ b/config/rootfiles/packages/rpz @@ -0,0 +1,20 @@ +etc/unbound/local.d/00-rpz.conf +etc/unbound/zonefiles +etc/unbound/zonefiles/allow.rpz +usr/sbin/rpz-config +usr/sbin/rpz-functions +usr/sbin/rpz-make +usr/sbin/rpz-metrics +usr/sbin/rpz-sleep +var/ipfire/addon-lang/rpz.de.pl +var/ipfire/addon-lang/rpz.en.pl +var/ipfire/addon-lang/rpz.es.pl +var/ipfire/addon-lang/rpz.fr.pl +var/ipfire/addon-lang/rpz.it.pl +var/ipfire/addon-lang/rpz.tr.pl +var/ipfire/backup/addons/includes/rpz +var/ipfire/dns/rpz +var/ipfire/dns/rpz/allowlist +var/ipfire/dns/rpz/blocklist +var/ipfire/menu.d/EX-rpz.menu +srv/web/ipfire/cgi-bin/rpz.cgi diff --git a/config/rpz/00-rpz.conf b/config/rpz/00-rpz.conf new file mode 100644 index 000000000..f005a4f2e --- /dev/null +++ b/config/rpz/00-rpz.conf @@ -0,0 +1,10 @@ +server: + module-config: "respip validator iterator" + +rpz: + name: allow.rpz + zonefile: /etc/unbound/zonefiles/allow.rpz + rpz-action-override: passthru + rpz-log: yes + rpz-log-name: allow + rpz-signal-nxdomain-ra: yes diff --git a/config/rpz/rpz-config b/config/rpz/rpz-config new file mode 100644 index 000000000..c72d50f9b --- /dev/null +++ b/config/rpz/rpz-config @@ -0,0 +1,130 @@ +#!/bin/bash +############################################################################### +# # +# IPFire.org - A linux based firewall # +# Copyright (C) 2024-2025 IPFire Team # +# # +# This program 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 3 of the License, or # +# (at your option) any later version. # +# # +# This program is distributed in the hope that it will be useful, # +# but WITHOUT ANY WARRANTY; without even the implied warranty of # +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # +# GNU General Public License for more details. # +# # +# You should have received a copy of the GNU General Public License # +# along with this program. If not, see . # +# # +############################################################################### + +version="2025-01-11 - v44" + +############### Functions ############### + +source /usr/sbin/rpz-functions + +############### Main ############### + +tagName="unbound" + +rpzAction="${1}" # input RPZ action +rpzName="${2}" # input RPZ name +rpzURL="${3}" # input RPZ URL +rpzOption1="${4}" # input RPZ option #1 +rpzOption2="${5}" # input RPZ option #2 + +rpzConfig="/etc/unbound/local.d/${rpzName}.rpz.conf" # output zone conf file +rpzFile="/etc/unbound/zonefiles/${rpzName}.rpz" # output for RPZ file + +rpzLog="yes" # log default is yes +ucReload="yes" # reload default is yes + +while [[ $# -gt 0 ]] ; do + case "$1" in + --no-log ) rpzLog="no" ;; + --no-reload ) ucReload="no" ; checkConf="no" ;; + esac + shift # Shift after checking all the cases to get next option +done + +case "${rpzAction}" in + # add new rpz list + add ) + check_name "${rpzName}" # is this a valid name? + # does this config already exist? If yes, then exit + if [[ -f "${rpzConfig}" ]] ; then + msg_log "error: rpz: duplicate - ${rpzConfig} already exists. exit" + exit 104 + fi + + # is this a valid URL? + regex='^https://[-[:alnum:]\+&@#/%?=~_|!:,.;]*[-[:alnum:]\+&@#/%=~_|]' + if ! [[ "${rpzURL}" =~ $regex ]] ; then + msg_log "error: rpz: the URL is not valid: \"${rpzURL}\". exit." + exit 105 + fi + + # create the zone config file + { + echo "rpz:" + echo " name: ${rpzName}.rpz" + echo " zonefile: ${rpzFile}" + echo " url: ${rpzURL}" + echo " rpz-action-override: nxdomain" + echo " rpz-log: ${rpzLog}" + echo " rpz-log-name: ${rpzName}" + echo " rpz-signal-nxdomain-ra: yes" + } > "${rpzConfig}" + + # set-up zonefile + # create an empty rpz file if it does not exist + if [[ ! -f "${rpzFile}" ]] ; then + touch "${rpzFile}" + # unbound requires these settings for rpz files + set_permissions "${rpzFile}" "${rpzConfig}" + fi + ;; + + # trash config file & rpz file + remove ) + if ! [[ -f "${rpzConfig}" ]] ; then + msg_log "error: rpz: cannot remove ${rpzConfig}, does not exist. exit" + exit 106 + fi + + msg_log "info: rpz: remove config file & rpz file \"${rpzName}\"" + rm "${rpzConfig}" + rm "${rpzFile}" + ;; + + reload ) + check_unbound_conf "${checkConf}" + ;; + + list ) + awk -F':' '/^\s*name:/{ gsub(/[[:blank:]]|\.rpz/, "",$2) ; NAME=$2 } \ + /^\s*url:/{ gsub(/[[:blank:]]/, "") ; print NAME"="$2":"$3} ' \ + /etc/unbound/local.d/*rpz.conf + exit + ;; + + unbound-restart ) + check_unbound_conf "${checkConf}" + unbound_restart + exit + ;; + + * ) + msg_log "error: rpz: missing or incorrect parameter" + printf "Usage: $(basename "$0")