ZeroDNS

a DNS server in Rust, which is inspired from chinadns/dnsmasq.

👷 WARNING: still in an active development!!!

Goals

• multiple protocols: UDP/TCP/DoT/DoH
• user-defined filters, includes lua or native rust codes

Quick Start

Client-Side

ZeroDNS provides similar functionality to dig, but supports more DNS protocols. Here are some examples:

$ # Simple resolve, will read nameserver from /etc/resolv.conf
$ zerodns resolve www.youtube.com
$ # Use short output, similar with 'dig +short ...'
$ zerodns resolve --short www.youtube.com
$ # Resolve over google UDP
$ zerodns resolve -s 8.8.8.8 www.youtube.com
$ # Resolve over google TCP
$ zerodns resolve -s tcp://8.8.8.8 www.youtube.com
$ # Resolve over google DoT
$ zerodns resolve -s dot://dns.google www.youtube.com
$ # Resolve over cloudflare DoH
$ zerodns resolve -s doh://1.1.1.1 www.youtube.com
$ # Resolve MX records
$ zerodns resolve -t mx gmail.com

Server-Side

Notice: ensure you have just installed on your machine!

run an example:

$ just r
$ dig @127.0.0.1 -p5454 www.youtube.com

Configuration

Here's an example configuration file:

# The settings of server
[server]
# will listen on tcp+udp
listen = "0.0.0.0:5454"
# use LRU cache with 1000 capacity
cache_size = 1000

##### FILTERS BEGIN #####

# alidns over udp
[filters.alidns]
kind = "proxyby"
props = { servers = ["223.5.5.5", "223.6.6.6"] }

# opendns over tcp
[filters.opendns]
kind = "proxyby"
props = { servers = ["tcp://208.67.222.222:443", "tcp://208.67.220.220:443"] }

# a chinadns filter:
#  - use trusted dns servers for oversea domain
#  - use mistrusted dns servers for Chinese domain
# NOTICE: require 'geoip_database', you can download from https://git.io/GeoLite2-Country.mmdb
[filters.chinadns]
kind = "chinadns"
props = { trusted = ["tcp://208.67.222.222:443", "tcp://208.67.220.220:443"], mistrusted = ["223.5.5.5", "223.6.6.6"], geoip_database = "GeoLite2-Country.mmdb" }

# a lua filter example which show how to resolve addr by lua, see src/filter/lua.rs for more infomation.
[filters.lua]
kind = "lua"
props.script = """
-- The filter entrance:
function handle(ctx)
  -- log something...
  for i,v in ipairs(ctx.request:questions()) do
    logger:info('---- question#'..i..': '..v.name)
  end

  -- resolve addr from 223.5.5.5
  local resp = resolve(ctx.request,'223.5.5.5')

  -- log something...
  for i,v in ipairs(resp:answers()) do
    logger:info('---- answers#'..i..': name='..v.name..', rdata='..v.rdata)
  end

  -- answer it!
  ctx:answer(resp)

end
"""

##### FILTERS END #####

##### RULES BEGIN #####

# NOTICE:
# - will check rules below one by one
# - the 'domain' field follows the glob syntax

# RULE-1: for those domains of '*.cn', use lua filter
[[rules]]
domain = "*.cn"
filters = ["lua"]

# RULE-2: for those domains of '*apple.com', use alidns filter
[[rules]]
domain = "*.apple.com"
filters = ["alidns"]

# RULE-3: for those domains of '*google*', use opendns filter
[[rules]]
domain = "*google*"
filters = ["opendns"]

# RULE-FINAL: use chinadns for others
[[rules]]
domain = "*"
filters = ["chinadns"]

##### RULES END #####

Client API

// TODO