AdGuardHome/internal/filtering
Ainar Garipov 87bad8c1c2 all: imp lint, names, tests 2024-03-21 16:39:12 +03:00
..
hashprefix Pull request 2147: all: upd deps, go, scripts 2024-02-08 20:39:18 +03:00
rewrite Pull request 2147: all: upd deps, go, scripts 2024-02-08 20:39:18 +03:00
rulelist filtering: imp id handling 2024-03-21 15:37:54 +03:00
safesearch filtering: imp id handling 2024-03-21 15:37:54 +03:00
tests
README.md
blocked.go Pull request 2176: AG-20945-rule-list-engine 2024-03-15 17:23:36 +03:00
dnsrewrite.go filtering: imp id handling 2024-03-21 15:37:54 +03:00
dnsrewrite_test.go
filter.go filtering: imp id handling 2024-03-21 15:37:54 +03:00
filter_test.go
filtering.go filtering: imp id handling 2024-03-21 15:37:54 +03:00
filtering_test.go
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 filtering: imp id handling 2024-03-21 15:37:54 +03:00
http_test.go
idgenerator.go all: imp lint, names, tests 2024-03-21 16:39:12 +03:00
idgenerator_internal_test.go all: imp lint, names, tests 2024-03-21 16:39:12 +03:00
rewritehttp.go Pull request 2147: all: upd deps, go, scripts 2024-02-08 20:39:18 +03:00
rewritehttp_test.go
rewrites.go Pull request 2149: 6711 watch hosts 2024-02-13 13:19:22 +03:00
rewrites_test.go
safesearch.go
safesearchhttp.go
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)
    }
}