badguardhome/internal/dnsfilter
Ainar Garipov a2d39c810a Pull request: dnsfilter: restore enum value
Merge in DNS/adguard-home from fix-filter-names to master

Squashed commit of the following:

commit 620d80df12878a1b236abb26cd2a331df998a3d5
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Mon Dec 14 20:02:41 2020 +0300

    dnsfilter: restore enum value
2020-12-14 20:12:57 +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: fix lint and naming issues vol. 2 2020-12-07 15:38:05 +03:00
dnsfilter.go Pull request: dnsfilter: restore enum value 2020-12-14 20:12:57 +03:00
dnsfilter_test.go Pull request #847: dnsfilter: add $dnstype handling 2020-11-24 19:55:05 +03:00
rewrites.go Pull request #847: dnsfilter: add $dnstype handling 2020-11-24 19:55:05 +03:00
rewrites_test.go Pull request #847: dnsfilter: add $dnstype handling 2020-11-24 19:55:05 +03:00
safesearch.go Pull request: all: fix lint and naming issues vol. 2 2020-12-07 15:38:05 +03:00
sbpc.go Pull request: all: fix lint and naming issues vol. 2 2020-12-07 15:38:05 +03:00
sbpc_test.go Pull request: all: fix lint and naming issues vol. 2 2020-12-07 15:38:05 +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)
    }
}