net/adblock/files/README.md

   1 # dns based ad/abuse domain blocking
   2
   3 ## Description
   4 A lot of people already use adblocker plugins within their desktop browsers, but what if you are using your (smart) phone, tablet, watch or any other wlan gadget...getting rid of annoying ads, trackers and other abuse sites (like facebook ;-) is simple: block them with your router. When the dns server on your router receives dns requests, you will sort out queries that ask for the resource records of ad servers and return a simple 'NXDOMAIN'. This is nothing but **N**on-e**X**istent Internet or Intranet domain name, if domain name is unable to resolved using the dns server, a condition called the 'NXDOMAIN' occurred.
   5
   6 ## Main Features
   7 * support of the following domain block list sources (free for private usage, for commercial use please check their individual licenses):
   8     * [adaway](https://adaway.org)
   9     * => infrequent updates, approx. 400 entries (enabled by default)
  10     * [adguard](https://adguard.com)
  11     * => numerous updates on the same day, approx. 12.000 entries
  12     * [blacklist]()
  13     * => static local blacklist, located by default in '/etc/adblock/adblock.blacklist'
  14     * [disconnect](https://disconnect.me)
  15     * => numerous updates on the same day, approx. 6.500 entries (enabled by default)
  16     * [dshield](http://dshield.org)
  17     * => daily updates, approx. 4.500 entries
  18     * [feodotracker](https://feodotracker.abuse.ch)
  19     * => daily updates, approx. 0-10 entries
  20     * [hphosts](https://hosts-file.net)
  21     * => monthly updates, approx. 50.000 entries
  22     * [malwaredomains](http://malwaredomains.com)
  23     * => daily updates, approx. 16.000 entries
  24     * [malwaredomainlist](http://www.malwaredomainlist.com)
  25     * => daily updates, approx. 1.500 entries
  26     * [openphish](https://openphish.com)
  27     * => numerous updates on the same day, approx. 1.800 entries
  28     * [palevo tracker](https://palevotracker.abuse.ch)
  29     * => daily updates, approx. 15 entries
  30     * [ransomware tracker](https://ransomwaretracker.abuse.ch)
  31     * => daily updates, approx. 150 entries
  32     * [rolist/easylist](https://easylist-downloads.adblockplus.org/rolist+easylist.txt)
  33     * => weekly updates, approx. 600 entries
  34     * [ruadlist/easylist](https://code.google.com/p/ruadlist)
  35     * => weekly updates, approx. 2.000 entries
  36     * [securemecca](http://www.securemecca.com)
  37     * => infrequent updates, approx. 25.000 entries
  38     * [shallalist](http://www.shallalist.de) (categories "adv" "costtraps" "spyware" "tracker" "warez" enabled by default)
  39     * => daily updates, approx. 32.000 entries (a short description of all shallalist categories can be found [online](http://www.shallalist.de/categories.html))
  40     * [spam404](http://www.spam404.com)
  41     * => infrequent updates, approx. 5.000 entries
  42     * [sysctl/cameleon](http://sysctl.org/cameleon)
  43     * => weekly updates, approx. 21.000 entries
  44     * [whocares](http://someonewhocares.org)
  45     * => weekly updates, approx. 12.000 entries
  46     * [winhelp](http://winhelp2002.mvps.org)
  47     * => infrequent updates, approx. 15.000 entries
  48     * [winspy](https://github.com/crazy-max/WindowsSpyBlocker)
  49     * => infrequent updates, approx. 120 entries
  50     * [yoyo](http://pgl.yoyo.org/adservers)
  51     * => weekly updates, approx. 2.500 entries (enabled by default)
  52     * [zeus tracker](https://zeustracker.abuse.ch)
  53     * => daily updates, approx. 440 entries
  54 * zero-conf like automatic installation & setup, usually no manual changes needed
  55 * simple but yet powerful adblock engine: adblock does not use error prone external iptables rulesets, http pixel server instances and things like that
  56 * automatically selects dnsmasq or unbound as dns backend
  57 * automatically selects uclient-fetch or wget as download utility (other tools like curl or aria2c are supported as well)
  58 * automatically supports a wide range of router modes, even AP modes are supported
  59 * full IPv4 and IPv6 support
  60 * supports tld compression (top level domain compression), this feature removes thousands of needless host entries from the block lists and lowers the memory footprint for the dns backends
  61 * each block list source will be updated and processed separately
  62 * block list source parsing by fast & flexible regex rulesets
  63 * overall duplicate removal in separate block lists
  64 * additional whitelist for manual overrides, located by default in /etc/adblock/adblock.whitelist
  65 * quality checks during block list update to ensure a reliable dns backend service
  66 * minimal status & error logging to syslog, enable debug logging to receive more output
  67 * procd based init system support (start/stop/restart/reload/suspend/resume/query)
  68 * procd based hotplug support, the adblock start will be solely triggered by network interface triggers
  69 * suspend & resume adblock actions temporarily without block list reloading
  70 * runtime statistics via ubus service call
  71 * query function to quickly identify blocked (sub-)domains, e.g. for whitelisting
  72 * optional: automatic block list backup & restore, backups will be (de-)compressed and restored on the fly in case of any runtime error
  73 * optional: add new adblock sources on your own via uci config
  74
  75 ## Prerequisites
  76 * [LEDE project](https://www.lede-project.org), tested with latest stable release (LEDE 17.01) and with current LEDE snapshot
  77 * a usual setup with an enabled dns backend at minimum - dump AP modes without a working dns backend are _not_ supported
  78 * a download utility: full versions (with ssl support) of 'wget', 'uclient-fetch', 'aria2c' or 'curl' are supported - the Chaos Calmer built-in busybox wget is not
  79     * Chaos Calmer: download & install the external 'wget' package
  80     * Designated Driver/Trunk: use built-in 'uclient-fetch' or download & install the external 'wget' package
  81     * for more configuration options see examples below
  82
  83 ## OpenWrt / LEDE trunk Installation & Usage
  84 * install 'adblock' (_opkg install adblock_) and that's it - the adblock start will be automatically triggered by procd interface triggers
  85 * start/stop/restart/reload/suspend/resume the adblock service manually with _/etc/init.d/adblock_
  86 * enable/disable your favored block list sources in _/etc/config/adblock_ - 'adaway', 'disconnect' and 'yoyo' are enabled by default
  87
  88 ## LuCI adblock companion package
  89 * for easy management of the various block list sources and all other adblock options you can also use a nice & efficient LuCI frontend
  90 * install 'luci-app-adblock' (_opkg install luci-app-adblock_)
  91 * the application is located in LuCI under 'Services' menu
  92 * _Thanks to Hannu Nyman for this great adblock LuCI frontend!_
  93
  94 ## Tweaks
  95 * **status/runtime statistics:** the adblock status and runtime statistics are available via ubus service call (see example below)
  96 * **debug logging:** for script debugging please set the config option 'adb\_debug' to '1' and check the runtime output with _logread -e "adblock"_
  97 * **storage expansion:** to process and store all block list sources at once it might helpful to enlarge your temp directory with a swap partition => see [openwrt wiki](https://wiki.openwrt.org/doc/uci/fstab) for further details
  98 * **add white-/blacklist entries:** add domain white- or blacklist entries to always-allow or -deny certain (sub) domains, by default both lists are empty and located in _/etc/adblock_. Please add one domain per line - ip addresses, wildcards & regex are _not_ allowed (see example below)
  99 * **backup & restore block lists:** enable this feature, to restore automatically the latest compressed backup of your block lists in case of any processing error (e.g. a single block list source is not available during update). Please use an (external) solid partition and _not_ your volatile router temp directory for this
 100 * **scheduled list updates:** for a scheduled call of the adblock service add an appropriate crontab entry (see example below)
 101 * **restrict/disable procd interface trigger:** to restrict the procd interface trigger to a (list of) certain wan interface(s) or to disable it at all, set 'adb\_iface' to an existing interface like 'wan' or to a non-existing like 'false'
 102 * **suspend & resume adblocking:** to quickly switch the adblock service 'on' or 'off', simply use _/etc/init.d/adblock [suspend|resume]_
 103 * **domain query:** to query the active block lists for a specific domain, please run _/etc/init.d/adblock query `<DOMAIN>`_ (see example below)
 104 * **divert dns requests:** to force dns requests to your local dns resolver add an appropriate firewall rule (see example below)
 105 * **add new list sources:** you could add new block list sources on your own via uci config, all you need is a source url and an awk one-liner (see example below)
 106 * **disable active dns probing in windows 10:** to prevent a yellow exclamation mark on your internet connection icon (which wrongly means connected, but no internet), please change the following registry key/value from "1" to "0" _HKLM\SYSTEM\CurrentControlSet\Services\NlaSvc\Parameters\Internet\EnableActiveProbing_
 107
 108 ## Further adblock config options
 109 * usually the pre-configured adblock setup works quite well and no manual config overrides are needed, all listed options apply to the 'global' config section:
 110     * adb\_enabled => main switch to enable/disable adblock service (default: '1', enabled)
 111     * adb\_debug => enable/disable adblock debug output (default: '0', disabled)
 112     * adb\_iface => set the procd interface trigger to a (list of) lan/wan interface(s) (default: 'wan wwan lan')
 113     * adb\_fetch => full path to a different download utility, see example below (default: not set, use wget)
 114     * adb\_fetchparm => options for the download utility, see example below (default: not set, use wget options)
 115
 116 ## Examples
 117
 118 **change default dns backend to 'unbound':**
 119 <pre><code>
 120 Adblock detects the presence of an active unbound dns backend and the block lists will be automatically pulled in by unbound.
 121 The adblock script deposits the sorted and filtered block lists in '/var/lib/unbound' where unbound can find them in its jail.
 122 If you use manual configuration for unbound, then just include the following line in your 'server:' clause:
 123
 124   include: "/var/lib/unbound/adb_list.*"
 125 </code></pre>
 126
 127 **configuration for different download utilities:**
 128 <pre><code>
 129 wget (default):
 130   option adb_fetch="/usr/bin/wget"
 131   option adb_fetchparm="--no-config --quiet --no-cache --no-cookies --max-redirect=0 --timeout=10 --no-check-certificate -O"
 132
 133 aria2c:
 134   option adb_fetch '/usr/bin/aria2c'
 135   option adb_fetchparm '-q --timeout=10 --allow-overwrite=true --auto-file-renaming=false --check-certificate=false -o'
 136
 137 uclient-fetch:
 138   option adb_fetch '/bin/uclient-fetch'
 139   option adb_fetchparm '-q --timeout=10 --no-check-certificate -O'
 140
 141 curl:
 142   option adb_fetch '/usr/bin/curl'
 143   option adb_fetchparm '-s --connect-timeout 10 --insecure -o'
 144 </code></pre>
 145
 146 **receive adblock statistics via ubus:**
 147 <pre><code>
 148 ubus call service get_data '{"name":"adblock"}
 149 This will output the active block lists and other runtime information as JSON, e.g.:
 150 {
 151     "adblock": {
 152         "adblock": {
 153             "active_lists": [
 154                 {
 155                     "palevo": "14",
 156                     "blacklist": "147",
 157                     "winspy": "138",
 158                     "adaway": "378",
 159                     "zeus": "397",
 160                     "rolist": "652",
 161                     "malwarelist": "1157",
 162                     "yoyo": "2272",
 163                     "ruadlist": "1793",
 164                     "ransomware": "1670",
 165                     "dshield": "190",
 166                     "openphish": "2672",
 167                     "disconnect": "2910",
 168                     "spam404": "5715",
 169                     "whocares": "8900",
 170                     "winhelp": "8528",
 171                     "adguard": "10790",
 172                     "securemecca": "5080",
 173                     "sysctl": "7906",
 174                     "malware": "14617",
 175                     "hphosts": "12450",
 176                     "shalla": "23926"
 177                 }
 178             ],
 179             "adblock_version": "2.5.0",
 180             "blocked_domains": "112302",
 181             "dns_backend": "dnsmasq",
 182             "last_rundate": "25.03.2017 21:09:12",
 183             "system": "LEDE Reboot SNAPSHOT r3867-313197d707"
 184         }
 185     }
 186 }
 187 </code></pre>
 188
 189 **cronjob for a regular block list update (/etc/crontabs/root):**
 190 <pre><code>
 191 0 06 * * *    /etc/init.d/adblock start
 192 </code></pre>
 193
 194 **blacklist entry (/etc/adblock/adblock.blacklist):**
 195 <pre><code>
 196 ads.example.com
 197
 198 This entry blocks the following (sub)domains:
 199   http://ads.example.com/foo.gif
 200   http://server1.ads.example.com/foo.gif
 201   https://ads.example.com:8000/
 202
 203 This entry does not block:
 204   http://ads.example.com.ua/foo.gif
 205   http://example.com/
 206 </code></pre>
 207
 208 **whitelist entry (/etc/adblock/adblock.whitelist):**
 209 <pre><code>
 210 here.com
 211
 212 This entry removes the following (sub)domains from the block lists:
 213   maps.here.com
 214   here.com
 215
 216 This entry does not remove:
 217   where.com
 218   www.adwhere.com
 219 </code></pre>
 220
 221 **query active block lists for a certain (sub-)domain, e.g. for whitelisting:**
 222 <pre><code>
 223 /etc/init.d/adblock query example.www.doubleclick.net
 224 ::: distinct results for domain 'example.www.doubleclick.net'
 225  no match
 226 ::: distinct results for domain 'www.doubleclick.net'
 227  adb_list.sysctl      : www.doubleclick.net
 228 ::: distinct results for domain 'doubleclick.net'
 229  adb_list.adaway      : ad-g.doubleclick.net
 230  adb_list.securemecca : 1168945.fls.doubleclick.net
 231  adb_list.sysctl      : 1435575.fls.doubleclick.net
 232  adb_list.whocares    : 3ad.doubleclick.net
 233
 234 The query function checks against the submitted (sub-)domain and recurses automatically to the upper top level domain(s).
 235 For every domain it returns the overall count plus a distinct list of active block lists with the first relevant result.
 236 In the example above whitelist "www.doubleclick.net" to free the submitted domain.
 237 </code></pre>
 238
 239 **divert dns requests to local dns resolver in /etc/config/firewall:**
 240 <pre><code>
 241 config redirect
 242     option name 'Divert DNS'
 243     option src 'lan'
 244     option proto 'tcp udp'
 245     option src_dport '53'
 246     option dest_port '53'
 247     option target 'DNAT'
 248 </code></pre>
 249
 250 **add a new block list source:**
 251 <pre><code>
 252 1. the easy way ...
 253 example: https://easylist-downloads.adblockplus.org/rolist+easylist.txt
 254 adblock already supports an easylist source, called 'ruadlist'. To add the additional local easylist
 255 as a new source, copy the existing config source 'ruadlist' section and change only
 256 the source name, the url and the description - that's all!
 257
 258 config source 'rolist'
 259   option enabled '0'
 260   option adb_src 'https://easylist-downloads.adblockplus.org/rolist+easylist.txt'
 261   option adb_src_rset '{FS=\"[|^]\"} \$0 ~/^\|\|([A-Za-z0-9_-]+\.){1,}[A-Za-z]+\^$/{print tolower(\$3)}'
 262   option adb_src_desc 'focus on romanian ad related domains plus generic easylist additions, weekly updates, approx. 600 entries'
 263
 264 2. a bit harder ...
 265 to add a really new source with different domain/host format you have to write a suitable
 266 awk one-liner on your own, so basic awk skills are needed. As a starting point check the already
 267 existing awk strings (adb_src_rset) in adblock config, maybe you need only small changes for your individual list.
 268 Download the desired list and test your new awk string locally with:
 269   cat new.list | awk 'fs__individual search__search core__result'
 270   'fs' => field separator (optional)
 271   'individual search' => individual search part to filter out needless list information
 272   'search core' => always '([A-Za-z0-9_-]+\.){1,}[A-Za-z]+', this is part of all list sources and should be unchanged
 273   'result' => always '{print tolower(\$n)}', only the output column 'n' may vary
 274 the output result should be a sequential list with one domain/host per line - nothing more.
 275
 276 If your awk one-liner works quite well, add a new source section in adblock config and test your new source
 277 </code></pre>
 278
 279 ## Support
 280 Please join the adblock discussion in this [forum thread](https://forum.lede-project.org/t/adblock-2-x-support-thread/507) or contact me by mail <dev@brenken.org>
 281
 282 ## Removal
 283 * stop all adblock related services with _/etc/init.d/adblock stop_
 284 * optional: remove the adblock package (_opkg remove adblock_)
 285
 286 Have fun!
 287 Dirk