AdGuardHome/internal/filtering
Eugene Burkov 94cf50a53d Pull request 1955: Upd libraries
Merge in DNS/adguard-home from upd-libs to master

Squashed commit of the following:

commit 72f4fb7d5ab8eaecb917a843dec56e3fa38b725c
Merge: 8defe106f 111005b8d
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Thu Aug 10 19:50:33 2023 +0300

    Merge branch 'master' into upd-libs

commit 8defe106fc982ba916f42d5722f1cc0152042d04
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Thu Aug 10 19:38:01 2023 +0300

    dnsforward: revert behavior

commit 8ccb2f675373772f8a6f829b80b317fda0c5f730
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Wed Aug 9 18:35:12 2023 +0300

    all: imp code

commit a3112d3438a466bae515e56a6ee97394066ba481
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Wed Aug 9 17:26:52 2023 +0300

    filtering: revert type

commit 56d2528fb4c8ee5504de0c6ec24050d63c8e6330
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Wed Aug 9 14:57:04 2023 +0300

    stats: fix sort

commit 0dbb446602b7536df508a8e53c4a532455c9d064
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Wed Aug 9 14:52:28 2023 +0300

    all: upd golibs & dnsproxy
2023-08-10 20:00:17 +03:00
..
hashprefix Pull request 1955: Upd libraries 2023-08-10 20:00:17 +03:00
rewrite Pull request 1877: 5913-fix-safesearch-ipv6 2023-06-19 15:45:01 +03:00
rulelist Pull request 1933: upd-golibs 2023-07-20 14:26:35 +03:00
safesearch Pull request 1933: upd-golibs 2023-07-20 14:26:35 +03:00
tests 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: 4865-refactor-dns-handlers 2022-09-02 14:52:19 +03:00
dnsrewrite_test.go Pull request: 4871 imp filtering 2022-09-23 13:23:35 +03:00
filter.go Pull request 1937: imp-filter-upd 2023-07-25 17:47:24 +03:00
filter_test.go Pull request: 5258-good-old-filters 2022-12-20 16:40:42 +03:00
filtering.go Pull request 1921: 6003-relax-scan-limit 2023-07-13 13:57:32 +03:00
filtering_test.go Pull request 1910: new-rulelist-parser 2023-07-07 18:27:33 +03:00
http.go Pull request 1910: new-rulelist-parser 2023-07-07 18:27:33 +03:00
http_test.go Pull request 1841: AG-21462-safebrowsing-parental-http-tests 2023-05-03 19:52:06 +03:00
README.md Pull request: all: less annoying pkg names 2021-05-21 16:15:47 +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 1955: Upd libraries 2023-08-10 20:00:17 +03:00
rewrites_test.go Pull request: 2499 rewrite: storage vol.2 2022-12-05 14:46:51 +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

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)
    }
}