AdGuardHome/internal/filtering
2024-05-15 13:34:12 +03:00
..
hashprefix all: sync with master 2024-03-12 18:15:58 +03:00
rewrite all: sync with master; upd chlog 2024-04-02 20:22:19 +03:00
rulelist all: sync with master 2024-05-15 13:34:12 +03:00
safesearch all: sync with master 2024-05-15 13:34:12 +03:00
tests Pull request: all: less annoying pkg names 2021-05-21 16:15:47 +03:00
blocked.go all: sync with master; upd chlog 2024-04-02 20:22:19 +03:00
dnsrewrite.go all: sync with master; upd chlog 2024-04-02 20:22:19 +03:00
dnsrewrite_test.go all: sync with master 2024-01-30 18:44:31 +03:00
filter.go all: sync with master; upd chlog 2024-04-02 20:22:19 +03:00
filter_test.go all: sync with master; upd chlog 2023-09-07 17:13:48 +03:00
filtering.go all: sync with master 2024-05-15 13:34:12 +03:00
filtering_test.go all: sync with master 2024-05-15 13:34:12 +03:00
hosts.go all: sync with master; upd chlog 2024-04-02 20:22:19 +03:00
hosts_test.go all: sync with master; upd chlog 2024-04-02 20:22:19 +03:00
http.go all: sync with master; upd chlog 2024-04-02 20:22:19 +03:00
http_test.go all: sync with master; upd chlog 2023-06-07 20:04:01 +03:00
idgenerator.go all: sync with master; upd chlog 2024-04-02 20:22:19 +03:00
idgenerator_internal_test.go all: sync with master 2024-05-15 13:34:12 +03:00
README.md Pull request: all: less annoying pkg names 2021-05-21 16:15:47 +03:00
rewritehttp.go all: sync with master 2024-03-12 18:15:58 +03:00
rewritehttp_test.go all: sync with master; upd chlog 2023-07-03 14:10:40 +03:00
rewrites.go all: sync with master 2024-03-12 18:15:58 +03:00
rewrites_test.go all: sync with master; upd chlog 2023-10-11 17:31:41 +03:00
safesearch.go all: sync with master 2024-05-15 13:34:12 +03:00
safesearchhttp.go all: sync with master; upd chlog 2023-09-07 17:13:48 +03:00
servicelist.go all: sync more; upd chlog 2024-04-03 21:30:46 +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)
    }
}