AdGuardHome/internal/dnsfilter
Eugene Burkov 5a50efadb2 Pull request: 2509 type-safety vol.1
Merge in DNS/adguard-home from 2509-type-safety to master

Updates #2509.

Squashed commit of the following:

commit 535968eb7de3a9e0817ddb57bc2320e5c5a55086
Author: Eugene Burkov <e.burkov@adguard.com>
Date:   Wed Jan 20 15:06:16 2021 +0300

    dhcpd: fix comments

commit dc79b80381fe7a8ecec6f9659fd23710c9229f59
Author: Eugene Burkov <e.burkov@adguard.com>
Date:   Wed Jan 20 14:08:10 2021 +0300

    all: improve docs

commit 156ebf6c9bad95f82cd121f019f3b59b77b18ba6
Author: Eugene Burkov <e.burkov@adguard.com>
Date:   Tue Jan 19 17:08:15 2021 +0300

    all: improve JSON encoding and decoding
2021-01-20 15:59:24 +03:00
..
tests Pull request: * all: move internal Go packages to internal/ 2020-10-30 13:32:02 +03:00
README.md Pull request:* all: remove github.com/joomcode/errorx dependency 2020-11-05 15:20:57 +03:00
blocked.go Pull request #886: all: allow multiple rules in dns filter results 2020-12-17 13:32:46 +03:00
dnsfilter.go Pull request: all: improve dnsrewrite handling 2020-12-28 18:41:50 +03:00
dnsfilter_test.go Pull request: 2508 ip conversion vol.1 2021-01-13 16:56:05 +03:00
dnsrewrite.go Pull request: dnsforward: add dnsrewrite tests 2021-01-14 15:30:39 +03:00
dnsrewrite_test.go Pull request: 2508 ip conversion vol.1 2021-01-13 16:56:05 +03:00
rewrites.go Pull request #886: all: allow multiple rules in dns filter results 2020-12-17 13:32:46 +03:00
rewrites_test.go Pull request: 2508 ip conversion vol.1 2021-01-13 16:56:05 +03:00
safebrowsing.go Pull request: 2509 type-safety vol.1 2021-01-20 15:59:24 +03:00
safebrowsing_test.go Pull request: 2508 ip conversion vol.1 2021-01-13 16:56:05 +03:00
safesearch.go Pull request: 2509 type-safety vol.1 2021-01-20 15:59:24 +03:00

README.md

AdGuard Home's DNS filtering go library

Example use:

[ -z "$GOPATH" ] && export GOPATH=$HOME/go
go get -d github.com/AdguardTeam/AdGuardHome/dnsfilter

Create file filter.go

package main

import (
    "github.com/AdguardTeam/AdGuardHome/dnsfilter"
    "log"
)

func main() {
    filter := dnsfilter.New()
    filter.AddRule("||dou*ck.net^")
    host := "www.doubleclick.net"
    res, err := filter.CheckHost(host)
    if err != nil {
        // temporary failure
        log.Fatalf("Failed to check host %q: %s", host, err)
    }
    if res.IsFiltered {
        log.Printf("Host %s is filtered, reason - %q, matched rule: %q", host, res.Reason, res.Rule)
    } else {
        log.Printf("Host %s is not filtered, reason - %q", host, res.Reason)
    }
}

And then run it:

go run filter.go

You will get:

2000/01/01 00:00:00 Host www.doubleclick.net is filtered, reason - 'FilteredBlackList', matched rule: '||dou*ck.net^'

You can also enable checking against AdGuard's SafeBrowsing:

package main

import (
    "github.com/AdguardTeam/AdGuardHome/dnsfilter"
    "log"
)

func main() {
    filter := dnsfilter.New()
    filter.EnableSafeBrowsing()
    host := "wmconvirus.narod.ru" // hostname for testing safebrowsing
    res, err := filter.CheckHost(host)
    if err != nil {
        // temporary failure
        log.Fatalf("Failed to check host %q: %s", host, err)
    }
    if res.IsFiltered {
        log.Printf("Host %s is filtered, reason - %q, matched rule: %q", host, res.Reason, res.Rule)
    } else {
        log.Printf("Host %s is not filtered, reason - %q", host, res.Reason)
    }
}