AdGuardHome/internal/dnsfilter
Ainar Garipov 48e82f9ab5 Pull request: 2479 simpl
Updates #2479.

Squashed commit of the following:

commit 0fdb0d041d0bd0d9af64513cf82397456a30e2f2
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Mon Mar 29 19:22:56 2021 +0300

    dnsfilter: add a comment

commit d5d6538b8b5133d7c1e9b242a8ac802448d40893
Merge: 6a09acc2 e710ce11
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Mon Mar 29 19:19:39 2021 +0300

    Merge branch 'master' into 2479-simpl

commit 6a09acc262
Author: jvoisin <julien.voisin@dustri.org>
Date:   Tue Dec 22 16:43:47 2020 +0100

    Generalise a construct to simplify a function
2021-03-29 19:35:35 +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: all: imp code, decr cyclo 2021-03-25 20:30:30 +03:00
blocked_test.go Added several blocked services 2021-02-04 18:16:01 +03:00
dnsfilter.go Pull request: dnsfilter: imp code, decr cyclo 2021-03-26 13:03:36 +03:00
dnsfilter_test.go Pull request: all: imp code, decr cyclo 2021-03-25 20:30:30 +03:00
dnsrewrite.go Pull request: dnsforward: add dnsrewrite tests 2021-01-14 15:30:39 +03:00
dnsrewrite_test.go Pull request: all: imp code, decr cyclo 2021-03-25 20:30:30 +03:00
rewrites.go Pull request: 2479 simpl 2021-03-29 19:35:35 +03:00
rewrites_test.go Pull request: 2639 use testify require vol.4 2021-03-11 17:32:58 +03:00
safebrowsing.go Pull request: all: imp code, decr cyclo 2021-03-25 20:30:30 +03:00
safebrowsing_test.go Pull request: all: imp code, decr cyclo 2021-03-25 20:30:30 +03:00
safesearch.go Pull request: all: imp code, decr cyclo 2021-03-25 20:30:30 +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)
    }
}