badguardhome/internal/filtering
Eugene Burkov b3210cfa7e Pull request: 3835 check ports properly
Merge in DNS/adguard-home from 3835-imp-error-msg to master

Updates #3835.

Squashed commit of the following:

commit ba31cb67833df9f293fe13be96a35c2a823f115b
Merge: 19c7dfc9 4be69d35
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Thu Dec 16 20:07:25 2021 +0300

    Merge branch 'master' into 3835-imp-error-msg

commit 19c7dfc96284a271d30d7111c86c439be3461389
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Thu Dec 16 19:42:10 2021 +0300

    all: imp more

commit 5b9c6a3e357238bf44ef800a6033a7671f27d469
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Thu Dec 16 18:57:02 2021 +0300

    all: introduce aghhttp

commit 29caa17200957aad2b98461573bb33d80931adcf
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Thu Dec 16 14:23:53 2021 +0300

    all: imp more

commit 754c020191d7b9518cb0e789f3f5741ba38c3cf4
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Wed Dec 15 20:53:41 2021 +0300

    all: imp code, log changes

commit ec712dd562f31fcc2fbc27e7035f926c79827444
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Wed Dec 15 18:40:54 2021 +0300

    home: check ports properly
2021-12-16 20:54:59 +03:00
..
tests Pull request: all: less annoying pkg names 2021-05-21 16:15:47 +03:00
README.md Pull request: all: less annoying pkg names 2021-05-21 16:15:47 +03:00
blocked.go Pull request: 3835 check ports properly 2021-12-16 20:54:59 +03:00
blocked_test.go Pull request: all: imp build tags 2021-06-15 19:42:41 +03:00
dnsrewrite.go Pull request: 3846 hosts querylog 2021-11-23 18:01:48 +03:00
dnsrewrite_test.go Pull request: 3846 filter lists ids 2021-11-26 18:25:43 +03:00
filtering.go Pull request: 3835 check ports properly 2021-12-16 20:54:59 +03:00
filtering_test.go Pull request: 3846 filter lists ids 2021-11-26 18:25:43 +03:00
rewrites.go Pull request: 3835 check ports properly 2021-12-16 20:54:59 +03:00
rewrites_test.go Pull request: 3846 filter lists ids 2021-11-26 18:25:43 +03:00
safebrowsing.go Pull request: 3835 check ports properly 2021-12-16 20:54:59 +03:00
safebrowsing_test.go Pull request: 3846 filter lists ids 2021-11-26 18:25:43 +03:00
safesearch.go Pull request: 3835 check ports properly 2021-12-16 20:54:59 +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/filtering

Create file filter.go

package main

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

func main() {
    filter := filtering.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/filtering"
    "log"
)

func main() {
    filter := filtering.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)
    }
}