luckyturtledev / crab-hole

🦀 Pi-Hole clone written in rust using hickory-dns/trust-dns

crab-hole's Issues

Split DNS

I want to forward DNS requests to an upstream based on the domain requested.

Let's assume an organization (mycorp.com) runs authoritative DNS servers for its own domain under dns.mycorp.com (at IP 100.100.100.100). I want to configure crab-hole so that all requests to any subdomain (as deep as necessary) of mycorp.com terminate at dns.mycorp.com, while all other requests go to Cloudflare for example.

See the following example requests:
www.subdomain.mycorp.com -> crab-hole uses dns.mycorp.com as Upstream
test.mycorp.com -> crab-hole uses dns.mycorp.com as Upstream
mycorp.com -> crab-hole uses dns.mycorp.com as Upstream

google.com -> crab-hole uses another configured Upstream
mail.google.com -> crab-hole uses another configured Upstream

Config-wise it could look the following:

[upstream]

[[upstream.name_servers]]
socket_addr = "[2606:4700:4700::1111]:853"
protocol = "tls"
tls_dns_name = "1dot1dot1dot1.cloudflare-dns.com"

[[upstream.name_servers]]
socket_addr = "100.100.100.100:85"
protocol = "udp"
domains = [
    "mycorp.com",
    "mycorp.eu"
]

enable dnssec at example config

see https://docs.rs/trust-dns-server/latest/trust_dns_server/store/forwarder/struct.ForwardConfig.html
https://docs.rs/trust-dns-resolver/0.22.0/trust_dns_resolver/config/struct.ResolverOpts.html#structfield.validate

default log level leaks ip querry domain now

Todo:

• wait for reaction at hickory-dns/hickory-dns#2014 first

The 0.1.5 release did not increase the package version

v0.1.4...v0.1.5

Feature: wifi login portal dection

Custom DNS

Pihole has the option of adding custom DNS entries. I would like to add internal DNS names to my private crab-hole.

Image per https://discourse.pi-hole.net/t/howto-using-pi-hole-as-lan-dns-server/533

Blocklist Storage

We need a datastructure that can efficiently store our blocklist and allow domain lookup. That means, for an input domain, we need to know if the domain itself or any domain it is a subdomain of. I see two possibilities:

• We just use a HashMap for the blocklist. Then the lookup needs to split the domain up into all domains it is a subdomain of, and we need (in the worst case) to check for each if it is part of the hash map
• We use a trie. It appears as if none of the libraries provided on crates.io suffice - the best they have is common prefix, but we need the largest superstring that is actually part of the tree, not any prefix of it. (also, we're running on suffixes, not prefixes)

Prometheus Exporter

In addition to the JSON stats API, a Prometheus native format would be great. This way, the stats can easily be ingested into Grafana or other dashboards.

https://prometheus.io/docs/concepts/data_model/

https://docs.rs/prometheus/latest/prometheus/

Support for DNSCrypt

You can find more information here: https://dnscrypt.info/

---

needs: hickory-dns/hickory-dns#4

quic: Not resuming any session

Crab-hole client can not get dns entry from a crab-hole sever via quic.
Querry the server directly works fine kdig +quic example.com @dns.luckyturtle.dev.
But if I querry my local carb-hole I get a time out.
kdig example.com @127.0.0.1:8053

crab-hole-crab-hole-1  | 2023-09-02T13:16:57Z  ⚙️ DEBUG crab_hole            > LowerQuery { name: LowerName(Name("example.com.")), original: Query { name: Name("example.com."), query_type: A, query_class: IN } }
crab-hole-crab-hole-1  | 2023-09-02T13:16:57Z  ⚙️ DEBUG rustls::client::hs   > No cached session for DnsName(DnsName(DnsName("dns.luckyturtle.dev")))
crab-hole-crab-hole-1  | 2023-09-02T13:16:57Z  ⚙️ DEBUG rustls::client::hs   > Not resuming any session
crab-hole-crab-hole-1  | 2023-09-02T13:16:57Z  ⚙️ DEBUG rustls::client::hs   > No cached session for DnsName(DnsName(DnsName("dns.luckyturtle.dev")))
crab-hole-crab-hole-1  | 2023-09-02T13:16:57Z  ⚙️ DEBUG rustls::client::hs   > Not resuming any session
crab-hole-crab-hole-1  | 2023-09-02T13:16:57Z  ⚙️ DEBUG rustls::client::hs   > No cached session for DnsName(DnsName(DnsName("dns.luckyturtle.dev")))
crab-hole-crab-hole-1  | 2023-09-02T13:16:57Z  ⚙️ DEBUG rustls::client::hs   > Not resuming any session

local docker-compose:

version: '3.3'
services:
    crab-hole:
        image: 'ghcr.io/luckyturtledev/crab-hole:v0.1'
        ports:
            - "8053:8053/udp"
        environment:
            - RUST_LOG=debug
        volumes:
            - './config.toml:/data/config.toml:ro'

local config:

[blocklist]
include_subdomains = true
lists = []

[[downstream]]
protocol = "udp"
listen = "[::]"
port = 8053

[[upstream.name_servers]]
socket_addr = "185.163.118.254:853"
protocol = "quic"
tls_dns_name = "dns.luckyturtle.dev"

depends on:

• hickory-dns/hickory-dns#2015