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     * [reg_cn](https://easylist-downloads.adblockplus.org/easylistchina+easylist.txt)
  33     * => regional blocklist for China, daily updates, approx. 1.600 entries
  34     * [reg_pl](http://adblocklist.org)
  35     * => regional blocklist for Poland, daily updates, approx. 50 entries
  36     * [reg_ro](https://easylist-downloads.adblockplus.org/rolist+easylist.txt)
  37     * => regional blocklist for Romania, weekly updates, approx. 600 entries
  38     * [reg_ru](https://code.google.com/p/ruadlist)
  39     * => regional blocklist for Russia, weekly updates, approx. 2.000 entries
  40     * [securemecca](http://www.securemecca.com)
  41     * => infrequent updates, approx. 25.000 entries
  42     * [shallalist](http://www.shallalist.de) (categories "adv" "costtraps" "spyware" "tracker" "warez" enabled by default)
  43     * => daily updates, approx. 32.000 entries (a short description of all shallalist categories can be found [online](http://www.shallalist.de/categories.html))
  44     * [spam404](http://www.spam404.com)
  45     * => infrequent updates, approx. 5.000 entries
  46     * [sysctl/cameleon](http://sysctl.org/cameleon)
  47     * => weekly updates, approx. 21.000 entries
  48     * [whocares](http://someonewhocares.org)
  49     * => weekly updates, approx. 12.000 entries
  50     * [winhelp](http://winhelp2002.mvps.org)
  51     * => infrequent updates, approx. 15.000 entries
  52     * [winspy](https://github.com/crazy-max/WindowsSpyBlocker)
  53     * => infrequent updates, approx. 120 entries
  54     * [yoyo](http://pgl.yoyo.org/adservers)
  55     * => weekly updates, approx. 2.500 entries (enabled by default)
  56     * [zeus tracker](https://zeustracker.abuse.ch)
  57     * => daily updates, approx. 440 entries
  58 * zero-conf like automatic installation & setup, usually no manual changes needed
  59 * simple but yet powerful adblock engine: adblock does not use error prone external iptables rulesets, http pixel server instances and things like that
  60 * automatically selects dnsmasq or unbound as dns backend
  61 * automatically selects uclient-fetch or wget as download utility (other tools like curl or aria2c are supported as well)
  62 * automatically supports a wide range of router modes, even AP modes are supported
  63 * full IPv4 and IPv6 support
  64 * 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
  65 * each block list source will be updated and processed separately
  66 * block list source parsing by fast & flexible regex rulesets
  67 * overall duplicate removal in separate block lists
  68 * additional whitelist for manual overrides, located by default in /etc/adblock/adblock.whitelist
  69 * quality checks during block list update to ensure a reliable dns backend service
  70 * minimal status & error logging to syslog, enable debug logging to receive more output
  71 * procd based init system support (start/stop/restart/reload/suspend/resume/query/status)
  72 * procd based hotplug support, the adblock start will be solely triggered by network interface triggers
  73 * suspend & resume adblock actions temporarily without block list reloading
  74 * runtime information available via LuCI & via 'status' init command
  75 * query function to quickly identify blocked (sub-)domains, e.g. for whitelisting
  76 * optional: automatic block list backup & restore, backups will be (de-)compressed and restored on the fly in case of any runtime error
  77 * optional: add new adblock sources on your own via uci config
  78
  79 ## Prerequisites
  80 * [LEDE project](https://www.lede-project.org), tested with latest stable release (LEDE 17.01) and with current LEDE snapshot
  81 * a usual setup with an enabled dns backend at minimum - dump AP modes without a working dns backend are _not_ supported
  82 * a download utility:
  83     * to support all blocklist sources a full version (with ssl support) of 'wget', 'uclient-fetch' with one of the 'libustream-*' ssl libraries, 'aria2c' or 'curl' is required
  84     * for limited devices with real memory constraints, adblock provides also a plain http option and supports wget-nossl and uclient-fetch (wihout libustream-ssl), too
  85     * for more configuration options see examples below
  86
  87 ## LEDE trunk Installation & Usage
  88 * install 'adblock' (_opkg install adblock_) and that's it - the adblock start will be automatically triggered by procd interface trigger
  89 * control the adblock service manually with _/etc/init.d/adblock_ start/stop/restart/reload/suspend/resume/status or use the LuCI frontend
  90 * enable/disable your favored block list sources in _/etc/config/adblock_ - 'adaway', 'disconnect' and 'yoyo' are enabled by default
  91
  92 ## LuCI adblock companion package
  93 * for easy management of the various block list sources and all other adblock options you can also use a nice & efficient LuCI frontend
  94 * install 'luci-app-adblock' (_opkg install luci-app-adblock_)
  95 * the application is located in LuCI under 'Services' menu
  96
  97 ## Tweaks
  98 * **runtime information:** the adblock status is available via _/etc/init.d/adblock status_ (see example below)
  99 * **debug logging:** for script debugging please set the config option 'adb\_debug' to '1' and check the runtime output with _logread -e "adblock"_
 100 * **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
 101 * **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)
 102 * **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
 103 * **scheduled list updates:** for a scheduled call of the adblock service add an appropriate crontab entry (see example below)
 104 * **restrict procd interface trigger:** restrict the procd interface trigger to a (list of) certain interface(s) (default: wan). To disable it at all, remove all entries
 105 * **suspend & resume adblocking:** to quickly switch the adblock service 'on' or 'off', simply use _/etc/init.d/adblock [suspend|resume]_
 106 * **domain query:** to query the active block lists for a specific domain, please run _/etc/init.d/adblock query `<DOMAIN>`_ (see example below)
 107 * **divert dns requests:** to force dns requests to your local dns resolver add an appropriate firewall rule (see example below)
 108 * **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)
 109 * **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_
 110
 111 ## Further adblock config options
 112 * 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:
 113     * adb\_enabled => main switch to enable/disable adblock service (default: '1', enabled)
 114     * adb\_debug => enable/disable adblock debug output (default: '0', disabled)
 115     * adb\_iface => set the procd interface trigger to a (list of) lan / wan interface(s) (default: 'wan')
 116     * adb\_fetch => full path to a different download utility, see example below (default: not set, use wget)
 117     * adb\_fetchparm => options for the download utility, see example below (default: not set, use wget options)
 118     * adb\_triggerdelay => additional trigger delay in seconds before adblock processing starts (default: '1')
 119
 120 ## Examples
 121 **change default dns backend to 'unbound':**
 122 <pre><code>
 123 Adblock detects the presence of an active unbound dns backend and the block lists will be automatically pulled in by unbound.
 124 The adblock script deposits the sorted and filtered block lists in '/var/lib/unbound' where unbound can find them in its jail.
 125 If you use manual configuration for unbound, then just include the following line in your 'server:' clause:
 126
 127   include: "/var/lib/unbound/adb_list.*"
 128 </code></pre>
 129
 130 **configuration for different download utilities:**
 131 <pre><code>
 132 wget (default):
 133   option adb_fetch="/usr/bin/wget"
 134   option adb_fetchparm="--no-config --quiet --no-cache --no-cookies --max-redirect=0 --timeout=10 --no-check-certificate -O"
 135
 136 aria2c:
 137   option adb_fetch '/usr/bin/aria2c'
 138   option adb_fetchparm '-q --timeout=10 --allow-overwrite=true --auto-file-renaming=false --check-certificate=false -o'
 139
 140 uclient-fetch:
 141   option adb_fetch '/bin/uclient-fetch'
 142   option adb_fetchparm '-q --timeout=10 --no-check-certificate -O'
 143
 144 curl:
 145   option adb_fetch '/usr/bin/curl'
 146   option adb_fetchparm '-s --connect-timeout 10 --insecure -o'
 147 </code></pre>
 148
 149 **receive adblock runtime information:**
 150 <pre><code>
 151 root@blackhole:~# /etc/init.d/adblock status
 152 ::: adblock runtime information
 153  status          : active
 154  adblock_version : 2.6.0
 155  blocked_domains : 113711
 156  fetch_info      : wget (built-in)
 157  dns_backend     : dnsmasq
 158  last_rundate    : 12.04.2017 13:08:26
 159  system          : LEDE Reboot SNAPSHOT r3900-399d5cf532
 160 </code></pre>
 161
 162 **cronjob for a regular block list update (/etc/crontabs/root):**
 163 <pre><code>
 164 0 06 * * *    /etc/init.d/adblock start
 165 </code></pre>
 166
 167 **blacklist entry (/etc/adblock/adblock.blacklist):**
 168 <pre><code>
 169 ads.example.com
 170
 171 This entry blocks the following (sub)domains:
 172   http://ads.example.com/foo.gif
 173   http://server1.ads.example.com/foo.gif
 174   https://ads.example.com:8000/
 175
 176 This entry does not block:
 177   http://ads.example.com.ua/foo.gif
 178   http://example.com/
 179 </code></pre>
 180
 181 **whitelist entry (/etc/adblock/adblock.whitelist):**
 182 <pre><code>
 183 here.com
 184
 185 This entry removes the following (sub)domains from the block lists:
 186   maps.here.com
 187   here.com
 188
 189 This entry does not remove:
 190   where.com
 191   www.adwhere.com
 192 </code></pre>
 193
 194 **query active block lists for a certain (sub-)domain, e.g. for whitelisting:**
 195 <pre><code>
 196 /etc/init.d/adblock query example.www.doubleclick.net
 197 ::: distinct results for domain 'example.www.doubleclick.net'
 198  no match
 199 ::: distinct results for domain 'www.doubleclick.net'
 200  adb_list.sysctl      : www.doubleclick.net
 201 ::: distinct results for domain 'doubleclick.net'
 202  adb_list.adaway      : ad-g.doubleclick.net
 203  adb_list.securemecca : 1168945.fls.doubleclick.net
 204  adb_list.sysctl      : 1435575.fls.doubleclick.net
 205  adb_list.whocares    : 3ad.doubleclick.net
 206
 207 The query function checks against the submitted (sub-)domain and recurses automatically to the upper top level domain(s).
 208 For every domain it returns the overall count plus a distinct list of active block lists with the first relevant result.
 209 In the example above whitelist "www.doubleclick.net" to free the submitted domain.
 210 </code></pre>
 211
 212 **divert dns requests to local dns resolver in /etc/config/firewall:**
 213 <pre><code>
 214 config redirect
 215     option name 'Divert DNS'
 216     option src 'lan'
 217     option proto 'tcp udp'
 218     option src_dport '53'
 219     option dest_port '53'
 220     option target 'DNAT'
 221 </code></pre>
 222
 223 **add a new block list source:**
 224 <pre><code>
 225 1. the easy way ...
 226 example: https://easylist-downloads.adblockplus.org/rolist+easylist.txt
 227 adblock already supports an easylist source, called 'ruadlist'. To add the additional local easylist
 228 as a new source, copy the existing config source 'ruadlist' section and change only
 229 the source name, the url and the description - that's all!
 230
 231 config source 'rolist'
 232   option enabled '0'
 233   option adb_src 'https://easylist-downloads.adblockplus.org/rolist+easylist.txt'
 234   option adb_src_rset '{FS=\"[|^]\"} \$0 ~/^\|\|([A-Za-z0-9_-]+\.){1,}[A-Za-z]+\^$/{print tolower(\$3)}'
 235   option adb_src_desc 'focus on romanian ad related domains plus generic easylist additions, weekly updates, approx. 600 entries'
 236
 237 2. a bit harder ...
 238 to add a really new source with different domain/host format you have to write a suitable
 239 awk one-liner on your own, so basic awk skills are needed. As a starting point check the already
 240 existing awk strings (adb_src_rset) in adblock config, maybe you need only small changes for your individual list.
 241 Download the desired list and test your new awk string locally with:
 242   cat new.list | awk 'fs__individual search__search core__result'
 243   'fs' => field separator (optional)
 244   'individual search' => individual search part to filter out needless list information
 245   'search core' => always '([A-Za-z0-9_-]+\.){1,}[A-Za-z]+', this is part of all list sources and should be unchanged
 246   'result' => always '{print tolower(\$n)}', only the output column 'n' may vary
 247 the output result should be a sequential list with one domain/host per line - nothing more.
 248
 249 If your awk one-liner works quite well, add a new source section in adblock config and test your new source
 250 </code></pre>
 251
 252 ## Support
 253 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>
 254
 255 ## Removal
 256 * stop all adblock related services with _/etc/init.d/adblock stop_
 257 * optional: remove the adblock package (_opkg remove adblock_)
 258
 259 Have fun!
 260 Dirk