History

Simon Zolin adb422fedf filtering: refactor; change API; add "filters_update_interval" setting + config: "filters_update_interval" * add /control/filtering_info * remove /control/filtering/enable * remove /control/filtering/disable * add /control/filtering_config * remove /control/filtering/status * add /control/filtering/set_url * remove /control/filtering/enable_url * remove /control/filtering/disable_url		2019-09-12 18:38:13 +03:00
..
tests	gometalinter	2019-01-25 20:13:57 +03:00
README.md	Rename from 'Adguard DNS' to 'AdGuard Home'.	2018-10-15 16:02:19 +03:00
dnsfilter.go	filtering: refactor; change API; add "filters_update_interval" setting	2019-09-12 18:38:13 +03:00
dnsfilter_test.go	* dnsfilter: use golibs/cache	2019-09-02 19:12:53 +03:00
helpers.go	* dnsfilter: remove code for filtering rules	2019-05-17 18:22:57 +03:00
safesearch.go	Update safesearch.go	2019-03-24 19:34:29 +01: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 '%s': %s", host, err)
    }
    if res.IsFiltered {
        log.Printf("Host %s is filtered, reason - '%s', matched rule: '%s'", host, res.Reason, res.Rule)
    } else {
        log.Printf("Host %s is not filtered, reason - '%s'", 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 '%s': %s", host, err)
    }
    if res.IsFiltered {
        log.Printf("Host %s is filtered, reason - '%s', matched rule: '%s'", host, res.Reason, res.Rule)
    } else {
        log.Printf("Host %s is not filtered, reason - '%s'", host, res.Reason)
    }
}