badguardhome/internal/dnsfilter
Eugene Burkov 0d0a419bd3 Pull request: 2574 external tests vol.1
Merge in DNS/adguard-home from 2574-external-tests to master

Updates #2574.

Squashed commit of the following:

commit cb7017aa7fc1c81c014c1fa7e0972b06748aff29
Merge: 2a073431 eeeb0383
Author: Eugene Burkov <e.burkov@adguard.com>
Date:   Fri Jan 29 15:43:41 2021 +0300

    Merge branch 'master' into 2574-external-tests

commit 2a0734311c5a6ddd2d9c3f56a4494a20b4197955
Author: Eugene Burkov <e.burkov@adguard.com>
Date:   Fri Jan 29 15:16:40 2021 +0300

    dnsfilter: imp docs

commit 49aff871282e2739d27fcbceefdf1bd005c21174
Author: Eugene Burkov <e.burkov@adguard.com>
Date:   Fri Jan 29 14:10:56 2021 +0300

    dnsfilter: imp docs

commit 11be89a5378c0e451f1b88dc48a2e8827ba38358
Author: Eugene Burkov <e.burkov@adguard.com>
Date:   Thu Jan 28 21:20:55 2021 +0300

    dnsfilter: fix go version trouble

commit 1ba4afd95bd739c18818ab0bea0ae70d59b880dc
Author: Eugene Burkov <e.burkov@adguard.com>
Date:   Thu Jan 28 17:42:29 2021 +0300

    dnsfilter: imp tests
2021-01-29 16:09:31 +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: 2574 external tests vol.1 2021-01-29 16:09:31 +03:00
dnsfilter_test.go Pull request: 2574 external tests vol.1 2021-01-29 16:09:31 +03:00
dnsrewrite.go Pull request: dnsforward: add dnsrewrite tests 2021-01-14 15:30:39 +03:00
dnsrewrite_test.go Pull request: 2574 external tests vol.1 2021-01-29 16:09:31 +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: 2574 external tests vol.1 2021-01-29 16:09:31 +03:00
safebrowsing.go Pull request: Minor code improvement - added tests for safebrowsing and parental control services 2021-01-27 15:21:39 +03:00
safebrowsing_test.go Pull request: 2574 external tests vol.1 2021-01-29 16:09:31 +03:00
safesearch.go Pull request: 2574 external tests vol.1 2021-01-29 16:09:31 +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)
    }
}