DNS proxy with ad blocker

This is a high performance DNS proxy with blacklist and whitelist feature to fight unwanted ads, also works for filtering unwanted domain when accessing your internet.

This project is written in Go, heavily inspired by looterz/grimd, and with helps of these great libraries:

• miekg/dns - Alternative (more granular) approach to a DNS library
• gobwas/glob - Go Globbing Library
• boltdb/bolt - Bolt, a pure Go key/value store database
• joyrexus/buckets - a Bolt wrapper streamlining simple tx and key scans

Installation

$ go get -v github.com/frengky/adblockr/...

This command will install adblockr binary into your GOPATH/bin

Configuration

First, create a configuration file adblockr.yml to getting started

# Bind DNS service to address  
listen_address: "127.0.0.1:5300"  
  
# List of upstream nameservers to be contacted when passed our blacklist check  
nameservers:  
  - "8.8.8.8:853"
  - "9.9.9.9:853"

# List of blacklist source uri, format: https://some/blacklist.txt or file:///local/path/file.txt  
blacklist_sources:  
  - https://raw.githubusercontent.com/StevenBlack/hosts/master/hosts
  - https://mirror1.malwaredomains.com/files/justdomains
  
# List of whitelisted domains, format: some.domain.com or *.domain.com  
whitelist_domains:  
  - "www.googleadservices.com"  
  
# Location of database file, if empty all blacklist will be stored on memory instead  
db_file: adblockr.db

Quick start

Running the DNS proxy verbosely with a configuration file:

$ adblockr serve -v -c /path/to/adblockr.yml

Privacy options

Enable DNS over TLS via adblockr.yml configuration file:

nameservers:  
  - "8.8.8.8:853"
  - "9.9.9.9:853"

By using upstream nameserver via port :853, all DNS queries will be secured using TLS connections.

Enable DNS over HTTPS via command line flags

$ adblockr serve -v --doh https://dns.google/dns-query

Using this options cause all DNS queries will be forwarded via HTTPS. The upstream nameservers in the configuration files will be ignored.

for more available commands, please see adblockr --help

Blacklist database

A database contains blacklisted domain names adblockr.db will be created when running for the first time, or you can also manually initialize the database (downloading all blacklist sources from adblockr.yml) using this command:

$ adblockr init-db

The adblockr.db blacklist database file will be created in the current working directory. Please only initialize the database when server is not running.

Tips

This DNS proxy server is created mainly for blacklisting/whitelisting domain purposes with basic caching mechanism. For an even better performance, it is recommended to run unbound as the upstream caching DNS resolver.