313 lines
18 KiB

  1. # dns based ad/abuse domain blocking
  2. ## Description
  3. 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.
  4. ## Main Features
  5. * support of the following domain block list sources (free for private usage, for commercial use please check their individual licenses):
  6. * [adaway](https://adaway.org)
  7. * => infrequent updates, approx. 400 entries (enabled by default)
  8. * [adguard](https://adguard.com)
  9. * => numerous updates on the same day, approx. 12.000 entries
  10. * [blacklist]()
  11. * => static local blacklist, located by default in '/etc/adblock/adblock.blacklist'
  12. * [disconnect](https://disconnect.me)
  13. * => numerous updates on the same day, approx. 6.500 entries (enabled by default)
  14. * [dshield](http://dshield.org)
  15. * => daily updates, approx. 4.500 entries
  16. * [feodotracker](https://feodotracker.abuse.ch)
  17. * => daily updates, approx. 0-10 entries
  18. * [hphosts](https://hosts-file.net)
  19. * => monthly updates, approx. 50.000 entries
  20. * [malwaredomains](http://malwaredomains.com)
  21. * => daily updates, approx. 16.000 entries
  22. * [malwaredomainlist](http://www.malwaredomainlist.com)
  23. * => daily updates, approx. 1.500 entries
  24. * [openphish](https://openphish.com)
  25. * => numerous updates on the same day, approx. 1.800 entries
  26. * [ransomware tracker](https://ransomwaretracker.abuse.ch)
  27. * => daily updates, approx. 150 entries
  28. * [reg_cn](https://easylist-downloads.adblockplus.org/easylistchina+easylist.txt)
  29. * => regional blocklist for China, daily updates, approx. 1.600 entries
  30. * [reg_id](https://easylist-downloads.adblockplus.org/abpindo+easylist.txt)
  31. * => regional blocklist for Indonesia, daily updates, approx. 800 entries
  32. * [reg_nl](https://easylist-downloads.adblockplus.org/easylistdutch+easylist.txt)
  33. * => regional blocklist for the Netherlands, weekly updates, approx. 1300 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. * supports five different dns backends / block list formats: dnsmasq, unbound, named (bind), kresd and dnscrypt-proxy
  61. * automatically selects uclient-fetch or wget as download utility (other tools like curl or aria2c are supported as well)
  62. * provides 'http only' mode without installed ssl library for all non-SSL block list sources
  63. * supports a wide range of router modes, even AP modes are supported
  64. * full IPv4 and IPv6 support
  65. * provides top level domain compression ('tld compression'), this feature removes thousands of needless host entries from the block list and lowers the memory footprint for the dns backends
  66. * each block list source will be updated and processed separately
  67. * block list source parsing by fast & flexible regex rulesets
  68. * overall duplicate removal in central block list (adb_list.overall)
  69. * additional whitelist for manual overrides, located by default in /etc/adblock/adblock.whitelist
  70. * quality checks during block list update to ensure a reliable dns backend service
  71. * minimal status & error logging to syslog, enable debug logging to receive more output
  72. * procd based init system support (start/stop/restart/reload/suspend/resume/query/status)
  73. * procd network interface trigger support or classic time based startup
  74. * suspend & resume adblock actions temporarily without block list reloading
  75. * output comprehensive runtime information via LuCI or via 'status' init command
  76. * query function to quickly identify blocked (sub-)domains, e.g. for whitelisting
  77. * strong LuCI support
  78. * optional: force dns requests to local resolver
  79. * optional: force overall sort / duplicate removal for low memory devices (handle with care!)
  80. * optional: 'manual mode' to re-use blocklist backups during startup, get fresh lists only via manual reload or restart action
  81. * optional: automatic block list backup & restore, they will be used in case of download errors or during startup in manual mode
  82. * optional: add new adblock sources on your own via uci config
  83. ## Prerequisites
  84. * [LEDE project](https://www.lede-project.org), tested with latest stable release (LEDE 17.01) and with current LEDE snapshot
  85. * a usual setup with an enabled dns backend at minimum - dump AP modes without a working dns backend are _not_ supported
  86. * a download utility:
  87. * 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
  88. * for limited devices with real memory constraints, adblock provides also a 'http only' option and supports wget-nossl and uclient-fetch (without libustream-ssl) as well
  89. * for more configuration options see examples below
  90. ## Installation & Usage
  91. * install 'adblock' (_opkg install adblock_)
  92. * at minimum configure the appropriate dns backend ('dnsmasq' by default) and enable the adblock service in _/etc/config/adblock_
  93. * control the adblock service manually with _/etc/init.d/adblock_ start/stop/restart/reload/suspend/resume/status or use the LuCI frontend
  94. ## LuCI adblock companion package
  95. * for easy management of the various block list sources and all other adblock options you should use the provided LuCI frontend
  96. * install 'luci-app-adblock' (_opkg install luci-app-adblock_)
  97. * the application is located in LuCI under 'Services' menu
  98. ## Tweaks
  99. * **runtime information:** the adblock status is available via _/etc/init.d/adblock status_ (see example below)
  100. * **debug logging:** for script debugging please set the config option 'adb\_debug' to '1' and check the runtime output with _logread -e "adblock"_
  101. * **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
  102. * **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)
  103. * **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
  104. * **scheduled list updates:** for a scheduled call of the adblock service add an appropriate crontab entry (see example below)
  105. * **change startup behaviour:** by default the startup will be triggered by the 'wan' procd interface trigger. Choose 'none' to disable automatic startups, 'timed' to use a classic timeout (default 30 sec.) or select another trigger interface.
  106. * **suspend & resume adblocking:** to quickly switch the adblock service 'on' or 'off', simply use _/etc/init.d/adblock [suspend|resume]_
  107. * **domain query:** to query the active block list for a specific domain, please run _/etc/init.d/adblock query `<DOMAIN>`_ (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. ## Further adblock config options
  111. * 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:
  112. * adb\_enabled => main switch to enable/disable adblock service (default: '0', disabled)
  113. * adb\_debug => enable/disable adblock debug output (default: '0', disabled)
  114. * adb\_dns => select the dns backend for your environment: 'dnsmasq', 'unbound', 'named', 'kresd' or 'dnscrypt-proxy' (default: 'dnsmasq')
  115. * adb\_dnsdir => target directory for the generated blocklist 'adb_list.overall' (default: not set, use dns backend default)
  116. * adb\_trigger => set the startup trigger to a certain interface, to 'timed' or to 'none' (default: 'wan')
  117. * adb\_triggerdelay => additional trigger delay in seconds before adblock processing begins (default: '1')
  118. * adb\_fetch => full path to a dedicated download utility, see example below (default: not set, use wget default)
  119. * adb\_fetchparm => options for the download utility, see example below (default: not set, use wget default options)
  120. * adb\_forcedns => force dns requests to local resolver (default: '0', disabled)
  121. * adb\_forcesrt => force overall sort on low memory devices with less than 64 MB RAM (default: '0', disabled)
  122. * adb\_manmode => do not automatically update block lists during startup, use backups instead (default: '0', disabled)
  123. ## Examples
  124. **change default dns backend to 'unbound':**
  125. Adblock deposits the sorted and filtered block list (adb_list.overall) in '/var/lib/unbound' where unbound can find them in its jail.
  126. If you use manual configuration for unbound, then just include the following line in your 'server' clause:
  127. <pre><code>
  128. include: "/var/lib/unbound/adb_list.overall"
  129. </code></pre>
  130. **change default dns backend to 'named' (bind):**
  131. Adblock deposits the sorted and filtered block list (adb_list.overall) in '/var/lib/bind' where bind can find them.
  132. To use the block list please modify the following bind configuration files:
  133. <pre><code>
  134. change '/etc/bind/named.conf', in the 'options' namespace add:
  135. response-policy { zone "rpz"; };
  136. and at the end of the file add:
  137. zone "rpz" {
  138. type master;
  139. file "/etc/bind/db.rpz";
  140. allow-query { none; };
  141. allow-transfer { none; };
  142. };
  143. create the new file '/etc/bind/db.rpz' and add:
  144. $TTL 2h
  145. $ORIGIN rpz.
  146. @ SOA localhost. root.localhost. (1 6h 1h 1w 2h)
  147. NS localhost.
  148. $INCLUDE /var/lib/bind/adb_list.overall
  149. </code></pre>
  150. **change default dns backend to 'kresd':**
  151. The knot-resolver (kresd) is only available on turris omnia devices. Currently there's no package for kresd in the official LEDE / OpenWrt package repository.
  152. Adblock deposits the sorted and filtered block list (adb_list.overall) in '/etc/kresd' where kresd can find them.
  153. To use the block list please create/modify the following kresd configuration files:
  154. <pre><code>
  155. TurrisOS > 3.6:
  156. edit '/etc/config/resolver' and change / uncomment the following options:
  157. forward_upstream '0'
  158. list rpz_file '/etc/kresd/adb_list.overall'
  159. TurrisOS < 3.6:
  160. edit '/etc/config/resolver' and change / uncomment the following options:
  161. forward_upstream '0'
  162. option include_config '/etc/kresd/custom.conf'
  163. create '/etc/kresd/custom.conf' and add:
  164. policy.add(policy.rpz(policy.DENY, '/etc/kresd/adb_list.overall'))
  165. policy.add(policy.all(policy.FORWARD({'8.8.8.8', '8.8.4.4'})))
  166. </code></pre>
  167. **change default dns backend to 'dnscrypt-proxy':**
  168. Adblock deposits the sorted and filtered block list (adb_list.overall) by default in '/tmp' where DNSCrypt-Proxy can find them.
  169. The blacklist option is not supported by default, because DNSCrypt-Proxy is compiled without plugins support.
  170. Take a custom LEDE build with plugins support to use this feature:
  171. <pre><code>
  172. edit '/etc/config/dnscrypt-proxy' and add the following option per dnscrypt-proxy instance:
  173. list blacklist 'domains:/tmp/adb_list.overall'
  174. </code></pre>
  175. **configuration for different download utilities:**
  176. <pre><code>
  177. wget (default):
  178. option adb_fetch '/usr/bin/wget'
  179. option adb_fetchparm '--quiet --no-cache --no-cookies --max-redirect=0 --timeout=10 --no-check-certificate -O'
  180. aria2c:
  181. option adb_fetch '/usr/bin/aria2c'
  182. option adb_fetchparm '-q --timeout=10 --allow-overwrite=true --auto-file-renaming=false --check-certificate=false -o'
  183. uclient-fetch:
  184. option adb_fetch '/bin/uclient-fetch'
  185. option adb_fetchparm '-q --timeout=10 --no-check-certificate -O'
  186. curl:
  187. option adb_fetch '/usr/bin/curl'
  188. option adb_fetchparm '-s --connect-timeout 10 --insecure -o'
  189. </code></pre>
  190. **receive adblock runtime information:**
  191. <pre><code>
  192. /etc/init.d/adblock status
  193. ::: adblock runtime information
  194. + adblock_status : enabled
  195. + adblock_version : 3.0.0
  196. + blocked_domains : 37406
  197. + fetch_utility : wget (built-in)
  198. + dns_backend : kresd (/etc/kresd)
  199. + last_rundate : 08.09.2017 21:21:21
  200. + system_release : OpenWrt omnia 15.05
  201. </code></pre>
  202. **cronjob for a regular block list update (/etc/crontabs/root):**
  203. <pre><code>
  204. 0 06 * * * /etc/init.d/adblock reload
  205. </code></pre>
  206. **blacklist entry (/etc/adblock/adblock.blacklist):**
  207. <pre><code>
  208. ads.example.com
  209. This entry blocks the following (sub)domains:
  210. http://ads.example.com/foo.gif
  211. http://server1.ads.example.com/foo.gif
  212. https://ads.example.com:8000/
  213. This entry does not block:
  214. http://ads.example.com.ua/foo.gif
  215. http://example.com/
  216. </code></pre>
  217. **whitelist entry (/etc/adblock/adblock.whitelist):**
  218. <pre><code>
  219. here.com
  220. This entry removes the following (sub)domains from the block list:
  221. maps.here.com
  222. here.com
  223. This entry does not remove:
  224. where.com
  225. www.adwhere.com
  226. </code></pre>
  227. **query active block list for a certain (sub-)domain, e.g. for whitelisting:**
  228. <pre><code>
  229. /etc/init.d/adblock query example.www.doubleclick.net
  230. root@turris:~# /etc/init.d/adblock query example.www.doubleclick.net
  231. ::: max. ten results for domain 'example.www.doubleclick.net'
  232. - no match
  233. ::: max. ten results for domain 'www.doubleclick.net'
  234. - no match
  235. ::: max. ten results for domain 'doubleclick.net'
  236. + doubleclick.net
  237. The query function checks against the submitted (sub-)domain and recurses automatically to the upper top level domain.
  238. For every (sub-)domain it returns the first ten relevant results.
  239. In the example above whitelist "doubleclick.net" to free the submitted domain.
  240. </code></pre>
  241. **add a new block list source:**
  242. <pre><code>
  243. 1. the easy way ...
  244. example: https://easylist-downloads.adblockplus.org/rolist+easylist.txt
  245. adblock already supports an easylist source, called 'ruadlist'. To add the additional local easylist
  246. as a new source, copy the existing config source 'ruadlist' section and change only
  247. the source name, the url and the description - that's all!
  248. config source 'rolist'
  249. option enabled '0'
  250. option adb_src 'https://easylist-downloads.adblockplus.org/rolist+easylist.txt'
  251. option adb_src_rset '{FS=\"[|^]\"} \$0 ~/^\|\|([A-Za-z0-9_-]+\.){1,}[A-Za-z]+\^$/{print tolower(\$3)}'
  252. option adb_src_desc 'focus on romanian ad related domains plus generic easylist additions, weekly updates, approx. 600 entries'
  253. 2. a bit harder ...
  254. to add a really new source with different domain/host format you have to write a suitable
  255. awk one-liner on your own, so basic awk skills are needed. As a starting point check the already
  256. existing awk strings (adb_src_rset) in adblock config, maybe you need only small changes for your individual list.
  257. Download the desired list and test your new awk string locally with:
  258. cat new.list | awk 'fs__individual search__search core__result'
  259. 'fs' => field separator (optional)
  260. 'individual search' => individual search part to filter out needless list information
  261. 'search core' => always '([A-Za-z0-9_-]+\.){1,}[A-Za-z]+', this is part of all list sources and should be unchanged
  262. 'result' => always '{print tolower(\$n)}', only the output column 'n' may vary
  263. the output result should be a sequential list with one domain/host per line - nothing more.
  264. If your awk one-liner works quite well, add a new source section in adblock config and test your new source
  265. </code></pre>
  266. ## Support
  267. 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>
  268. ## Removal
  269. * stop all adblock related services with _/etc/init.d/adblock stop_
  270. * optional: remove the adblock package (_opkg remove adblock_)
  271. Have fun!
  272. Dirk