AdGuardHome/internal/filtering
Eugene Burkov 28cfde9212 Pull request 1966: 6050 upd urlfilter
Merge in DNS/adguard-home from upd-urlfilter to master

Updates #6050.

Squashed commit of the following:

commit 80337ab02d616e25fa455e46c9535c088b5c5ea5
Merge: fb2cfd1a5 31f7aaecc
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Wed Aug 23 16:50:49 2023 +0300

    Merge branch 'master' into upd-urlfilter

commit fb2cfd1a5c94d92030fc8832615764f100d010e5
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Wed Aug 23 16:22:43 2023 +0300

    dnsforward: imp code, docs

commit 2900333bb85d4e064db9de27bd5bfe7c3ef00747
Merge: 977ed35e4 2bfc9fcb1
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Tue Aug 22 18:06:05 2023 +0300

    Merge branch 'master' into upd-urlfilter

commit 977ed35e4ed377f1031721d58e0fcb58de1e74ac
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Tue Aug 22 17:06:30 2023 +0300

    all: log changes

commit 1228a0770485799bf50bbe68005dbb0ba9a96a9c
Merge: 78305eb2e 4b4036fa6
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Tue Aug 22 16:51:42 2023 +0300

    Merge branch 'master' into upd-urlfilter

commit 78305eb2ebc3854dd11ce35d6b4c7eecccd7cc78
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Tue Aug 22 15:55:05 2023 +0300

    all: upd urlfilter

commit 63a29e18d5034e5f9433121ff7e7c45aebfa1f0f
Merge: 748c53430 762e5be97
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Mon Aug 21 20:12:49 2023 +0300

    Merge branch 'master' into upd-urlfilter

commit 748c5343020b0c6d4d4f16eb3d30b875c0a94e0f
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Mon Aug 21 20:07:44 2023 +0300

    all: imp code, docs

commit 91975140f3305a6793e07142f7c9a75120a4ce8c
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Thu Aug 17 16:16:19 2023 +0300

    all: upd urlfilter
2023-08-23 16:58:24 +03:00
..
hashprefix Pull request 1955: Upd libraries 2023-08-10 20:00:17 +03:00
rewrite Pull request 1966: 6050 upd urlfilter 2023-08-23 16:58:24 +03:00
rulelist Pull request 1933: upd-golibs 2023-07-20 14:26:35 +03:00
safesearch Pull request 1966: 6050 upd urlfilter 2023-08-23 16:58:24 +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 1883: 951-blocked-services-client-schedule 2023-06-27 18:03:07 +03:00
dnsrewrite.go Pull request 1964: AG-23599 use hostsfile 2023-08-22 16:45:11 +03:00
dnsrewrite_test.go Pull request 1966: 6050 upd urlfilter 2023-08-23 16:58:24 +03:00
filter.go Pull request: 6020-rulelist-name 2023-08-11 13:55:49 +03:00
filter_test.go Pull request: 6020-rulelist-name 2023-08-11 13:55:49 +03:00
filtering.go Pull request 1966: 6050 upd urlfilter 2023-08-23 16:58:24 +03:00
filtering_test.go Pull request 1966: 6050 upd urlfilter 2023-08-23 16:58:24 +03:00
http.go Pull request 1966: 6050 upd urlfilter 2023-08-23 16:58:24 +03:00
http_test.go Pull request 1841: AG-21462-safebrowsing-parental-http-tests 2023-05-03 19:52:06 +03:00
rewritehttp.go Pull request: 1577: rewrite edit http api 2023-05-12 13:04:19 +03:00
rewritehttp_test.go Pull request: 1577: rewrite edit http api 2023-05-12 13:04:19 +03:00
rewrites.go Pull request 1966: 6050 upd urlfilter 2023-08-23 16:58:24 +03:00
rewrites_test.go Pull request 1966: 6050 upd urlfilter 2023-08-23 16:58:24 +03:00
safesearch.go Pull request 1803: 5685-fix-safe-search 2023-04-06 14:12:50 +03:00
safesearchhttp.go Pull request 1803: 5685-fix-safe-search 2023-04-06 14:12:50 +03:00
servicelist.go Pull request 1950: upd-all 2023-08-02 15:58: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/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)
    }
}