AdGuardHome/internal/filtering
Ainar Garipov 5cc05e2c4b Pull request 2187: upd-golibs
Squashed commit of the following:

commit 63c14cf0eb395f58149f5a82ff1389353f7f8127
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Tue Apr 2 20:10:10 2024 +0300

    all: imp code, docs

commit 185ccdd1d9f5acc8376fabeac647f6fddcf108b5
Merge: b6ca80a9f d4fff41b3
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Tue Apr 2 20:04:23 2024 +0300

    Merge branch 'master' into upd-golibs

commit b6ca80a9f639394758cc9000345c132a713c183c
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Tue Apr 2 20:01:10 2024 +0300

    all: upd to tags

commit 474f62319befbe22cf1bccd2320cd0d3da1629b1
Author: Ainar Garipov <a.garipov@adguard.com>
Date:   Tue Mar 26 16:33:45 2024 +0300

    all: upd golibs
2024-04-03 13:44:51 +03:00
..
hashprefix Pull request 2147: all: upd deps, go, scripts 2024-02-08 20:39:18 +03:00
rewrite Pull request 2187: upd-golibs 2024-04-03 13:44:51 +03:00
rulelist Pull request 2182: AG-20945-rule-list-id 2024-03-21 18:45:34 +03:00
safesearch Pull request 2182: AG-20945-rule-list-id 2024-03-21 18:45:34 +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 2176: AG-20945-rule-list-engine 2024-03-15 17:23:36 +03:00
dnsrewrite.go Pull request 2182: AG-20945-rule-list-id 2024-03-21 18:45:34 +03:00
dnsrewrite_test.go Pull request 2108: 6541 hosts nodata 2023-12-18 14:43:08 +03:00
filter.go Pull request 2187: upd-golibs 2024-04-03 13:44:51 +03:00
filter_test.go Pull request: AG-25263 dns config 2023-09-04 17:18:43 +03:00
filtering.go Pull request 2187: upd-golibs 2024-04-03 13:44:51 +03:00
filtering_test.go Pull request 1966: 6050 upd urlfilter 2023-08-23 16:58:24 +03:00
hosts.go Pull request 2176: AG-20945-rule-list-engine 2024-03-15 17:23:36 +03:00
hosts_test.go Pull request 2176: AG-20945-rule-list-engine 2024-03-15 17:23:36 +03:00
http.go Pull request 2182: AG-20945-rule-list-id 2024-03-21 18:45:34 +03:00
http_test.go Pull request 1841: AG-21462-safebrowsing-parental-http-tests 2023-05-03 19:52:06 +03:00
idgenerator.go Pull request 2187: upd-golibs 2024-04-03 13:44:51 +03:00
idgenerator_internal_test.go Pull request 2182: AG-20945-rule-list-id 2024-03-21 18:45:34 +03:00
rewritehttp.go Pull request 2147: all: upd deps, go, scripts 2024-02-08 20:39:18 +03:00
rewritehttp_test.go Pull request: 1577: rewrite edit http api 2023-05-12 13:04:19 +03:00
rewrites.go Pull request 2149: 6711 watch hosts 2024-02-13 13:19:22 +03:00
rewrites_test.go Pull request 2017: 6226 legacy rewrite sort 2023-09-19 17:58:37 +03:00
safesearch.go Pull request 1803: 5685-fix-safe-search 2023-04-06 14:12:50 +03:00
safesearchhttp.go Pull request: AG-25263 dns config 2023-09-04 17:18:43 +03:00
servicelist.go Pull request 2173: upd-all 2024-03-13 17:59:21 +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)
    }
}